The intercom API reference.
URL https://developers.intercom.com
License MIT
The intercom API reference.
With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
Â
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Â
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
Â
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.
The type of message that was sent. Can be email, inapp, facebook or twitter.
{ "type": "user_message", "id": "1488971108", "created_at": 1667560812, "subject": "Greetings", "body": "Hello", "message_type": "inapp", "conversation_id": "64619700005570" }
You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.
🚧 Sending for visitors
There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.
This will return the Message model that has been created.
🚧 Retrieving Associated Conversations
As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.
You can create a message
The kind of message being created. Values: in_app or email.
The content of the message. HTML and plaintext are supported.
The style of the outgoing message. Possible values plain or personal.
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.
curl -i -X POST \ https://api.intercom.io/messages \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "from": { "type": "user", "id": "66fd02669ffbe52cc8b3aaf8" }, "body": "heyy", "referer": "https://twitter.com/bob" }'
{ "type": "user_message", "id": "403918228", "created_at": 1727857254, "body": "heyy", "message_type": "inapp", "conversation_id": "312" }