Intercom API (unofficial showcase)
POST/events/summaries

Create event summaries

Creates event summaries that track how often an event occurred and when it first and last occurred for a user. Supply the user's user_id and an event_summaries object containing event names, counts, and timestamps. Use past-tense verb-noun event names, such as updated-plan.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Event summary data for a user, including each event's name, occurrence count, and first and last timestamps.

user_idstringoptional
Your identifier for the user.
event_summariesobjectoptional
A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.

2 status codes
200Returns a successful response confirming the event summaries were created.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. Include a user_id to identify the user, and provide event names, counts, and first and last occurrence timestamps in event_summaries.