Lightweight Event Listening API
The Lightweight Event Listening API enables you to send information about customer events to MXO , without triggering any optimizations or tracking and capture points. There is also no requirement to use OAUTH authentication with this API.
To trigger optimizations or retrieve customer data, use the Interaction or Customer Data APIs.
Available API Calls
We provide the following API calls:
Method | Summary | Details |
---|---|---|
POST | /one/rt/track//events | Send customer activity to MXO. |
What does the Request URL look like?
POST <servername>/one/rt/track/<sk>/events
Example URL without TID
POST https://myoneserver.thunderhead.com/one/rt/track/ONE-5BTO1FBU1O-1109/events
Example URL with TID
POST https://myoneserver.thunderhead.com/one/rt/track/ONE-5BTO1FBU1O-1109/events?tid=dedc2983-4666-4641-8047-61250a878f89
Where the URL comprises:
Field | Description |
---|---|
servername | Name of your MXO server. |
sk | Site Key. |
tid | TID, if required. |
Can I pass in other parameters using the API?
Yes, you can. For example, you may want to pass in information about campaign codes or the promotion a customer has signed up for. Just add those parameters to the URI.
How can I check that an Interaction is being triggered?
Use Monitoring to check that an Interaction is being triggered for a specific customer key.
Example Use Cases
- Registering customer interest in a promotion they sign up for through a call center agent.
- Passing information about key customer sentiment updates to MXO from a Social Listening solution.
- Sending a location proximity event to MXO from a physical Touchpoint, when a customer visits a bank and triggers a beacon for a location service, such as Localz.
- Sending key customer events based on CRM triggers or workflows.
Example API Call
An example Lightweight Event API request, is as follows:
Request
Field | Description |
---|---|
Request Method | POST |
Request URL | https://myoneserver.thunderhead.com/one/rt/track/ONE-5BTO1FBU1O-1109/events |
Request Headers | Content-Type: application/json; charset=utf-8 |
Request Body* |
|
*Where Request Body comprises:
Parameter | Description |
---|---|
uri | Matched against a Base Touchpoint and Interaction Point path in MXO . |
properties | Any properties that provide context for the event. |
ck | The customer key for a specific customer. |
Response
Expected Response Code
200 SUCCESS
Expected Response Body
{
"statusCode": 200,
"tid":"dedc2983-4666-4641-8047-61250a878f89"
}