POST /api/v1/customers/{identifier}/events
Send an event associated with a person, referenced by the identifier in the path. There are three defined event type
values: page
, screen
and event
. Page and screen events represent website page views and mobile app screen views respectively; the name
for these event types is intended to be the page or screen a person visited or viewed. Any other event, is given the event
type.
We automatically trim leading and trailing spaces from event names.
Reserved Properties
There are a few important values which, if sent with the events that trigger campaigns, will override your campaign settings:
from_address
recipient
reply_to
When using the Javascript snippet to track events, you must call the Behavioral Tracking API call after identifying the customer or the event will not associate with the customer’s profile.
Servers
- https://track.customer.io
Path parameters
Name | Type | Required | Description |
---|---|---|---|
identifier |
Yes |
The unique value representing a person. You may identify a person by |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.