Skip to content
Home/
REST API Reference
/
/
Data Event

Data Event

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

typestring

The type of the object

Value:"event"
Example:"event"
event_namestringrequired

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.

Example:"invited-friend"
created_atinteger, (date-time)required

The time the event occurred as a UTC Unix timestamp

Example:1671028894
user_idstring

Your identifier for the user.

Example:"314159"
idstring

Your identifier for a lead or a user.

Example:"8a88a590-e1c3-41e2-a502-e0649dbf721c"
intercom_user_idstring

The Intercom identifier for the user.

Example:"63a0979a5eeebeaf28dd56ba"
emailstring

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

Example:"frodo.baggins@example.com"
metadataobject

Optional metadata about the event.

Example:
{
  "invite_code": "ADDAFRIEND"
}
{
  "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"
  }
}