The intercom API reference.
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
Create Data Event Summaries Request
You can send a list of event summaries for a 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.
{ "user_id": "314159", "event_summaries": { "event_name": "invited-friend", "count": 1, "first": 1671028894, "last": 1671028894 } }
Create Message Request Payload
You can create a message
Any of:
You can create a message
The kind of message being created. Values: in_app or email.
Enum"in_app""email"
Example: "in_app"
The content of the message. HTML and plaintext are supported.
Example: "Hello there"
The style of the outgoing message. Possible values plain or personal.
Example: "plain"
The sender of the message. If not provided, the default sender will be used.
The sender of the message. If not provided, the default sender will be used.
The time the message was created. If not provided, the current time will be used.
Example: 1590000000
{ "message_type": "in_app", "subject": "Thanks for everything", "body": "Hello there", "template": "plain", "from": { "type": "admin", "id": 394051 }, "to": { "type": "user", "id": "536e564f316c83104c000020" }, "created_at": 1590000000, "create_conversation_without_contact_reply": true }