The intercom API reference.
Home//Tickets
Tickets
Unstable Introduction
Changelog (Unstable)
Intercom API
Admins
AI Content
Articles
Away Status Reasons
Brands
Calls
Companies
Contacts
Conversations
Custom Object Instances
Data Attributes
Data Connectors
Data Events
Data Export
Emails
Fin Agent
Help Center
Internal Articles
Jobs
Macros
Messages
News
Notes
Segments
Subscription Types
Switch
Tags
Teams
Ticket States
Ticket Type Attributes
Ticket Types
Visitors
Workflows
Models
Export
Folders
WhatsApp
Intercom API (Unstable)
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/
AI Content
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.",
SchemasOperations
Custom Object Instances
Everything about your Custom Object instances.
Permission Requirements
From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.
SchemasOperations
Fin Agent
Access Fin programmatically via the Fin Agent API endpoints.
Please reach out to your accounts team to discuss access and tailored, hands-on support.
Integration is centered around two endpoints (/fin/start and /fin/reply) and a set of webhook events that notify your application of Fin's status and responses.
Webhook Events
Configure a webhook endpoint in the Fin Agent API settings to receive events. See the setup guide for configuration details.
fin_status_updated- Fired when Fin's status changes (escalated, resolved, complete)fin_replied- Fired when Fin sends a reply to the user
All webhook requests include an X-Fin-Agent-API-Webhook-Signature header for request validation.
Schemas
Ticket
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.
Example: "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_.
Example: {"_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.
Example: 1663597223
The last time the ticket was updated as a UTC Unix timestamp.
Example: 1663597260
The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.
Example: 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": { "type": "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, "previous_ticket_state_id": "7493" }
Ticket Part
A Ticket Part represents a message in the ticket.
The previous state of the ticket.
Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
The state of the ticket.
Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
The author that wrote or triggered the part. Can be a bot, admin, team or user.
The app package code if this part was created via API. Note this field won't show if the part was not created via API.
Example: "text-integration"
{ "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, "app_package_code": "text-integration", "updated_attribute_data": { "attribute": { … }, "value": { … } } }