GET /events
🚧
Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days
The events belonging to a customer can be listed by sending a GET request to https://api.intercom.io/events
with a user or lead identifier along with a type
parameter. The identifier parameter can be one of user_id
, email
or intercom_user_id
. The type
parameter value must be user
.
https://api.intercom.io/events?type=user&user_id={user_id}
https://api.intercom.io/events?type=user&email={email}
https://api.intercom.io/events?type=user&intercom_user_id={id}
(this call can be used to list leads)
The email
parameter value should be url encoded when sending.
You can optionally define the result page size as well with the per_page
parameter.
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
Name | Type | Required | Description |
---|---|---|---|
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
filter |
Object | Yes | |
type |
String | Yes |
The value must be user |
summary |
Boolean | No |
summary flag |
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.