Event API Basics
Introduction
Infinity’s Professional and Enterprise editions supports an Event API which is used to fire in custom event triggers to the Infinity Tracking system, such as when doing real-time CRM integration.
The Event API is available on the following secure URL:
https://ict.infinity-tracking.net/event
Input Format
- Input data needs to be supplied using standard HTTP GET arguments.
- URL parameters need to be encoded, and for spaces we support either ‘%20’ or ‘+’.
Response Format
Successful requests will be responded with a 200 response code, unsuccessful requests due to invalid parameters will receive a 400 response code
Required parameters
- igrp (int) - IGRP event is associated to.
Available parameters
- act (string) Optional - Action of Event (such as DOWNLOAD, EXIT, TRANSACTION), will default to “sale” if not supplied.
- vid (string) Optional - Infinity Visitor ID to associate this event to.
- callRef (string) Optional - Infinity Call Reference to associate this event to.
- t (string) Optional - Title of Event (such as title of product purchased).
- value (string) Optional - Value of this event (aka Event Margin).
- dt (string) Optional - UTC Datetime of this event, (format: YYYY-MM-DD HH:MM:SS), defaults to ‘now’.
- txv (string) Optional - Transaction Value of this event.
- txc (string) Optional - Transaction Currency of this event (three-letter ISO-4217 currency code, USD, GBP etc).
- txr (string) Optional - Unique Transaction Reference of this event (can be useful with de-duping rules).
- matchMode (string) Optional - Either ‘exact’ or ‘intelligent’ to enable intelligent matching.
- callStartDt (string) Optional - UTC datetime (format: YYYY-MM-DD HH:MM:SS) of when the call started. Only applicable when intelligent matching is enabled.
- srcPhoneNumber (string) Optional - The caller ID in E.164, ‘anonymous’ can be used for anonymous caller IDs. Only applicable when intelligent matching is enabled.
Test Events
If the txr field begins with the word ‘test’ then any event fired in will be voided and will not show in your metrics.
This allows you to test your integration and see the events associated to a visitor in the Portal without adding test transactions to your report totals.
Reserved Actions
The following action values (sent in the act field) are reserved and will be rejected if sent to the event API.
- land - used for identifying marketing sources.
- page - used for in-page tracking.
- call* - used for call and real-time call event tracking (includes any action code beginning with “call”, e.g. “callconfirm”, “calllead”, etc.