API Changelog

Export Message data through our API

You can use the API to export data for all messages sent in a given timeframe. This data will be valuable in analysing the performance of your messages or joining message engagement data with user data external to Intercom to attribute performance. You can see the three operations you'll have to perform to retrieve this in our reference.

List Tag dependencies on deletion

If a tag has dependencies and cannot be deleted, we will now return an error message listing those dependent objects. Previously, we would have failed without listing dependencies. See the Delete a tag section in our reference for a sample response.

Switch API

You can use the Switch API to deflect phone calls to the Intercom Messenger. Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.

Conversation Webhook Refactor

With this change, we've updated the webhooks Conversation payloads to match the latest version of the conversation API model.

Webhook payload & topics versioning

We have introduced versioning to webhook payloads and webhook topics.

New Webhook Topics

New Contact Topics

Renamed all user/lead topics to start with a "contact." prefix. We have Versioned User/Lead Topics and Payloads to allowed us to easily update the Contact topics and payloads to more closely align with our current Contact model without breaking any existing apps. Additionaly we have added a new topic "contact.lead.updated" to enable customers and partners to subscribe to changes on leads

Fix for source.author.type field in case of auto message from a team

The source.author.type field in the Conversation Model has been updated to have the value of "team" for cases where a conversation is started with an auto message from a team. Previously the value would be "admin" for this case.

Add fields to the contact model

Add location.country_code, location.continent_code, referrer, utm_campaign, utm_content, utm_medium, utm_source, and utm_term to the Contact Model

Update companies

Update companies using Update a Company

Fix conversation search using author name and email

Searching for conversation using the author's name or email with exact matches and special characters now returns the expected results.

Conversation Topic Information in Conversation Response

We've updated our Conversation API to support Conversation Topics as a read-only attribute.

• See top level Conversation Topic data related to conversations within any returned Conversations Model.

Support for Conversation Data Attributes

We've updated both our Conversation and Data Attribute APIs to support the addition of data attributes for conversations.

• See data attributes associated to conversations within any returned Conversations Model.
• Update a conversation's data attribute values through the Conversations API.
• List all data attributes associated to conversations through the Data Attributes API in order to understand which data attributes can be added to conversations.

Maintain conversation context with both team and admin assignee's

We found that it was increasingly important for you to keep persistent context of where a conversation originated from - no matter how many people handled it previously. We also wanted to reduce compexity of identifying which conversations are owned by who, particularly when using the Conversation Search endpoint.

As a result, you can now specify both a team and an admin as assignee's of a conversation. We show both an admin_assignee_id and a team_assignee_id in the conversation object. This replaces the assignee object and is therefore a breaking change. See more on the feature in our Help Center and take a look at our Conversation API reference for example objects.

View the title of a conversation

You can now see the added `title` of a conversation within all returned Conversation objects. This can only be added through the UI, or if a conversation was started via email whereby the subject will be the title. See our Conversation API reference for the updated model.

Redact a conversation part

You can now redact a conversation part or the source message of a conversation. See our Conversation API reference for further detail.

List attached segments for contacts and companies

You can now fetch a list of segments associated to a contact or a company. See our Contacts reference and Companies reference respectitvely to understand more.

Installation Health Check Endpoint

There may be issues that result in your app running into a state where it no longer functions after (or during) installation. In order to alert users and encourage them to solve this, we provide a Health Check which is designed to increase re-activation of your app and decrease any loss in retention.

Our Health Check webhook system sends a request every 24 hours to check on the health of your app. Instead of waiting these 24 hours, we now offer you the possibility to proactively notify us of when an app's state (for a given workspace) might have changed. See our Health Check guide for more on how to make this call.

Introducing the Articles API

We've now released a brand new way for you to access your Articles and Help Center within Intercom - through the API! This includes:

• A fully RESTful Articles endpoint which allows you to create rich & multi-lingual articles, fetch these by retrieving one or listing all, and which can be kept in sync with external repositories through updating their settings and content.
• A fully RESTful Help Center endpoint in order to manage the overall layout of your single-language or multilingual Help Center through the collections and sections under which your Articles live.

Contact, Conversation & Data Attribute APIs

We’re excited to share that we’ve now launched a major update to our API - giving you more powerful, contextual, and intuitive access to your data:

• A new, strictly RESTful Contacts API that combines users and leads — collectively known as “contacts” — and enables you to search for the exact contacts you need by filtering using any combination of fields, like location or a custom NPS score. Plus, the API exposes new attributes, like last_contacted and browser_version, and uses cursor-based pagination to give you access to all of your contacts without restrictions.
• An updated Conversations API that enables you to tag conversations directly, search and retrieve conversations by any combination of fields, and access more granular attributes, like timestamps and out-of-the-box metrics such as time_to_first_response and median_time_to_reply.
• A new Data Attributes API that lets you create and update custom data attributes, set a label and description for each, and build a dropdown list of defined attribute options. This means your app users can more easily leverage data when targeting and communicating with customers and leads.

Listing Data Attributes

We've modified the way data attributes are retrieved via our Data Attributes API. You can now retrieve a list of all data attributes by sending a GET request to the data_attributes endpoint.

• Listing customer data attributes - you can list customer data attributes by specifying a model parameter in the request URL with the value customer.
• Listing company data attributes - you can list company data attributes by specifying a model parameter in the request URL with the value company.

With the introduction of this change, customer and company data attributes can no longer be listed by using the old endpoints. For example, sending a request to the data_attributes/customer endpoint and sending a request to the data_attributes/company will no longer work.

Validating Custom Data Attributes

Custom Data Attributes created via the API must now use the same naming rules as the ones created via the UI. Names can therefore only contain alphanumeric characters, currency symbols, and hyphens.

Adding owner_id to User & Lead objects

We now expose a user or lead's account owner through the `owner_id` attribute. This will be the integer for an admin's id, meaning you can use this to make a call to our Admin API and get more details on the given owner.

Removing archived Custom Data Attributes from User responses

Archived Custom Data Attributes will no longer be present on the User model in API responses.

Removing Teams from Admin responses

The Admins endpoint will no longer return Teams in its responses. The Teams endpoint should be used instead.

Introducing Canvas Kit

Say hello to a quicker and easier way to build contextual and action-oriented apps embedded into Intercom's UI. With the launch of Canvas Kit, you keep all the capabilities of embedding apps in the Messenger, and gain:

• Capbilities for emebedding apps in Inbox - you can now build apps for the conversation details within Intercom's Inbox product. Take a look at our revampped Canvas Kit guides to understand just how easy it is.
• New Components - to make it easy to display data and input larger voucher, we've launched Data Table and Text Area components.
• Canvas Kit Builder - preview the JSON of your app to see what it will look like and how people can interact with it. The Builder is embedded throuhgout the docs but can also be accessed here.

Removing the users object from Canvas Kit request payloads

Instead of sending a users object within Canvas Kit requests, we now send a customer object instead. This returns exactly the same payload but also includes leads.

Removing the app_id key from Canvas Kit request payloads

Instead of sending an app_id key within Canvas Kit requests, we now send a workspace key instead. This returns exactly the same information as the value.

Adding an author object to Conversation payloads

We now return an author object within Conversation and Conversation Part objects sent throughout our REST API responses and Canvas Kit requests. This will contain the name and email of the message's author.

Preventing null for unsubscribed_from_emails

The API will now return an error if unsubscribed_from_emails is set to null for User requests.

Removing personally identifiable information (PII) from our API & Webhooks

Across our API & Webhooks, we will no longer return the last_seen_ip, location_data.longitude, location_data.latitude, and user_agent_data for users, leads, and visitors. This is part of an effort to keep customers data secure and uphold the availability of Intercom across services that require such information to not be exposed.

View activity logs for admins through our API

You can now get a log of activities taken by all admins in an app through our API. Simply send a GET request to https://api.intercom.io/admins/activity_logs. You can see request, params, and responses on our reference.

Set waiting since attribute to null for admin replies

In previous versions of our API, the value of the waiting_since attribute on the Conversation model is set to 2000 years in the future if the last reply is from an admin. This change sets the value of waiting_since to null instead.

List users by email returns users only

Previously, the list users by email endpoint returned a list of users and contacts. It will now return users only.

Allow contacts to be viewed/listed by phone

Previously, the you could list contacts by email only. Now you can also list them by phone.

New Conversations Part Redacted Webhook

There is a new webhook which fires when a conversation part is redacted.

New Conversations Rating Added Webhook

There is a new webhook which fires when a rating is added to a conversation.

The full list of changes in this version is:

• Users endpoint - Find multiple users via email
• Conversations endpoint - Adding more information for the user's first reply
• Messenger framework - new_canvas no longer accepted
• Messenger framework - Disable component option
• Webhooks - Four new webhook topics added

Users endpoint - Find multiple users via email

Previously if you searched for a user via email it would return an error if more than one user existed with the email. It returned a user object. Now it will return the same list object as with list users.

Conversations endpoint - Adding more information for user's first reply

It is now possible to get more information about your users first response. Customer have asked for this feature so they can better understand key metrics which may help identify patterns around what encouraged your customers to reply to a particular message. Similarly, it will also allow you to prioritise messages based on whether they were delivered as Auto-Messages, Bot messages or Manual Messages for example.

The new information will be available in the conversation model object returned when you list your conversations. It will contain:

• Source URL - The URL for the page from where your customer replied. This will not be available in all cases, e.g. when a customer replies via email.
• Channel - The channel the replay occurred within e.g. via email, in a conversation or via a 3rd party integration such as twitter or facebook
• Created at time - The time the users response was created
• How was the original message delivered - Was it an Auto-Message or a Campaigns Message or a Manual Message for example.

New or updated Attributes

The conversation model will include the follow new attributes

Customer First reply model

Conversations endpoint - Adding more information to tags

It is now possible to get more information about the conversation's tags when both fetching one conversation and listing all conversations. There's two new attributes you can see in the tag object of a conversation:

Messenger framework - new_canvas no longer accepted

During the beta launch of the Messenger framework we accepted both new_canvas and canvas as valid names for the canvas object returned to Intercom during the request flows. The new_canvas name is no longer accepted as a valid name for the canvas object.

Messenger framework - Disable component option

This version includes the ability to disable certain messenger framework components. This allows you to prevent certain components, such as elements in a list, from being selected. This may occur when customers are signed up to certain packages and have restricted options for some categories. The components which you can now disable are:

• Input
• Button
• List + each list item
• Dropdown + each dropdown option
• Single Select + each single select option
  For each of the above components it simply adds one optional boolean parameter which can be set to identify whether this component should be disabled or not

New webhook topics

This version includes a number of new webhook topics to which you can now subscribe. The new topics are described in the table below. To find out more about webhooks and learn how to subscribe to these topics please see our Setting up Webhooks page.