You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a Content-Type
of application/json
.
When using the JavaScript API, adding the code to your app makes the Events API available. Once added, you can submit an event using the trackEvent
method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.
With the Ruby client you pass a hash describing the event to Intercom::Event.create
, or call the track_user
method directly on the current user object (e.g. user.track_event
).
NB: For the JSON object types, please note that we do not currently support nested JSON structure.
Type Description Example String The value is a JSON String"source":"desktop"
Number The value is a JSON Number "load": 3.67
Date The key ends with the String _date
and the value is a Unix timestamp, assumed to be in the UTC timezone. "contact_date": 1392036272
Link The value is a HTTP or HTTPS URI. "article": "https://example.org/ab1de.html"
Rich Link The value is a JSON object that contains url
and value
keys. "article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}
Monetary Amount The value is a JSON object that contains amount
and currency
keys. The amount
key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. "price": {"amount": 34999, "currency": "eur"}
Lead Events
When submitting events for Leads, you will need to specify the Lead's id
.
Metadata behaviour
Event de-duplication
The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is strongly recommended to send a second granularity Unix timestamp in the created_at
field.
Duplicated events are responded to using the normal 202 Accepted
code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.
202 Accepted
with an empty body.401 Unauthorized
or 403 Forbidden
response code.404 Not Found
.500
response code and may contain an error message in the body.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4