The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.
{ "from": { "type": "user", "id": "536e564f316c83104c000020" }, "body": "Hello" }
Array of objects representing the options of the list, with value as the key and the option as the value. At least two options are required.
The model that the data attribute belongs to.
The readable description you see in the UI for the attribute.
{ "data_type": "options", "options": [ { … }, { … } ], "name": "My Data Attribute", "model": "contact", "description": "My Data Attribute Description", "messenger_writable": false }
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.
The time the event occurred as a UTC Unix timestamp
The unique identifier for the contact (lead or user) which is given by Intercom.
An email address for your user. An email should only be used where your application uses email to uniquely identify users.
{ "event_name": "invited-friend", "created_at": 1671028894, "user_id": "314159", "id": "8a88a590-e1c3-41e2-a502-e0649dbf721c", "email": "frodo.baggins@example.com", "metadata": { "invite_code": "ADDAFRIEND" } }