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.",
Tickets are how you track requests from your users.
The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.
"1390"
An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are _default_title_ and _default_description_.
{"default_title":"Found a bug","default_description":"The button's not working"}
A ticket type, used to define the data fields to be captured in a ticket.
The time the ticket was created as a UTC Unix timestamp.
1663597223
The last time the ticket was updated as a UTC Unix timestamp.
1663597260
The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.
1663597260
An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.
A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.
{ "type": "ticket", "id": "1295", "ticket_id": "1390", "category": "Customer", "ticket_attributes": { "_default_title_": "Found a bug", "_default_description_": "The button's not working" }, "ticket_state": { "id": "12", "category": "in_progress", "internal_label": "With Dev Team", "external_label": "In Progress" }, "ticket_type": { "type": "ticket_type", "id": "1295", "category": "Customer", "name": "Bug", "description": "A bug that has been reported.", "icon": "🐞", "workspace_id": "ecahpwf5", "ticket_type_attributes": { … }, "ticket_states": { … }, "archived": false, "created_at": 0, "updated_at": 0 }, "contacts": { "type": "contact.list", "contacts": [ … ] }, "admin_assignee_id": "1295", "team_assignee_id": "1295", "created_at": 1663597223, "updated_at": 1663597260, "open": true, "snoozed_until": 1663597260, "linked_objects": { "type": "list", "total_count": 100, "has_more": false, "data": [ … ] }, "ticket_parts": { "type": "ticket_part.list", "ticket_parts": [ … ], "total_count": 2 }, "is_shared": true }
A Ticket Part represents a message in the ticket.
The previous state of the ticket.
"submitted"
The state of the ticket.
"submitted"
The author that wrote or triggered the part. Can be a bot, admin, team or user.
{ "type": "ticket_part", "id": "3", "part_type": "comment", "body": "<p>Okay!</p>", "previous_ticket_state": "submitted", "ticket_state": "submitted", "created_at": 1663597223, "updated_at": 1663597260, "assigned_to": { "type": "contact", "id": "1a2b3c" }, "author": { "type": "admin", "id": "274", "name": "Operator", "email": "operator+abcd1234@intercom.io" }, "attachments": [ { … } ], "external_id": "abcd1234", "redacted": false }
A ticket state, used to define the state of a ticket.
The category of the ticket state
"in_progress"
The state the ticket is currently in, in a human readable form - visible in Intercom
"With Dev Team"
{ "id": "12", "category": "in_progress", "internal_label": "With Dev Team", "external_label": "In Progress" }
A ticket state, used to define the state of a ticket.
The category of the ticket state
"in_progress"
The state the ticket is currently in, in a human readable form - visible in Intercom
"With Dev Team"
The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.
"In Progress"
{ "id": "12", "category": "in_progress", "internal_label": "With Dev Team", "external_label": "In Progress", "archived": false, "ticket_types": { "type": "list", "data": [ … ] } }
A ticket type, used to define the data fields to be captured in a ticket.
String representing the object's type. Always has the value ticket_type.
"ticket_type"
A list of attributes associated with a given ticket type.
{ "type": "ticket_type", "id": "1295", "category": "Customer", "name": "Bug", "description": "A bug that has been reported.", "icon": "🐞", "workspace_id": "ecahpwf5", "ticket_type_attributes": { "type": "string", "ticket_type_attributes": [ … ] }, "ticket_states": { "type": "list", "data": [ … ] }, "archived": false, "created_at": 0, "updated_at": 0 }
Payload of the request to reply on behalf of a contact using their intercom_user_id
The time the reply was created. If not provided, the current time will be used.
1590000000
A list of image URLs that will be added as attachments. You can include up to 10 URLs.
curl -i -X POST \ 'https://api.intercom.io/tickets/{id}/reply' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: Unstable' \ -d '{ "message_type": "comment", "type": "user", "intercom_user_id": "6687d27460233569304d22b5", "body": "Thanks again :)" }'
{ "type": "ticket_part", "id": "172", "part_type": "note", "body": "<h2>An Unordered HTML List</h2>\n<ul>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ul>\n<h2>An Ordered HTML List</h2>\n<ol>\n<li>Coffee</li>\n<li>Tea</li>\n<li>Milk</li>\n</ol>", "created_at": 1720177271, "updated_at": 1720177271, "author": { "id": "991268521", "type": "admin", "name": "Ciaran412 Lee", "email": "admin412@email.com" }, "attachments": [], "redacted": false }