Data Event

Data events are used to notify Intercom of changes to your data.

type
string

The type of the object

Value: "event"
event_name
required
string

The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan.

created_at
required
integer <date-time>

The time the event occurred as a UTC Unix timestamp

user_id
string

Your identifier for the user.

id
string

Your identifier for a lead or a user.

intercom_user_id
string

The Intercom identifier for the user.

email
string

An email address for your user. An email should only be used where your application uses email to uniquely identify users.

object

Optional metadata about the event.

{ "type": "event", "event_name": "invited-friend", "created_at": 1671028894, "user_id": "314159", "id": "8a88a590-e1c3-41e2-a502-e0649dbf721c", "intercom_user_id": "63a0979a5eeebeaf28dd56ba", "email": "frodo.baggins@example.com", "metadata": { "invite_code": "ADDAFRIEND" } }