Intercom

Learn how to use Intercom with Composio

Overview

SLUG

INTERCOM

Description

Intercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read_user,write_user,read_company,write_company,read_conversation,write_conversation,read_admin,write_admin,read_tag,write_tag,read_event,write_event,read_segment,write_segment,read_count,write_count,read_data_attribute,write_data_attribute,read_ticket,write_ticket,read_team,write_team,read_note,write_note,read_news,write_news,read_article,write_article,read_webhook,write_webhook,offline_access
full
stringDefaults to https://api.intercom.io
bearer_token
string

Tools

SLUG: INTERCOM_ATTACH_A_CONTACT_TO_A_COMPANY

You can attach a company to a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_ADD_SUBSCRIPTION_TO_A_CONTACT

You can add a specific subscription to a contact. in intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. this will return a subscription type model for the subscription type that was added to the contact.

Action Parameters

consent_type
stringRequired
contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_ADD_TAG_TO_A_CONTACT

You can tag a specific contact. this will return a tag object for the tag that was added to the contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_CREATE_AN_ARTICLE

You can create a new article by making a post request to `https://api.intercom.io/articles`.

Action Parameters

author_id
integerRequired
body
string
description
string
parent_id
integer
parent_type
string
state
string
title
stringRequired
translated__content__ar__author__id
integer
translated__content__ar__body
string
translated__content__ar__created__at
integer
translated__content__ar__description
string
translated__content__ar__state
string
translated__content__ar__title
string
translated__content__ar__type
string
translated__content__ar__updated__at
integer
translated__content__ar__url
string
translated__content__bg__author__id
integer
translated__content__bg__body
string
translated__content__bg__created__at
integer
translated__content__bg__description
string
translated__content__bg__state
string
translated__content__bg__title
string
translated__content__bg__type
string
translated__content__bg__updated__at
integer
translated__content__bg__url
string
translated__content__bs__author__id
integer
translated__content__bs__body
string
translated__content__bs__created__at
integer
translated__content__bs__description
string
translated__content__bs__state
string
translated__content__bs__title
string
translated__content__bs__type
string
translated__content__bs__updated__at
integer
translated__content__bs__url
string
translated__content__ca__author__id
integer
translated__content__ca__body
string
translated__content__ca__created__at
integer
translated__content__ca__description
string
translated__content__ca__state
string
translated__content__ca__title
string
translated__content__ca__type
string
translated__content__ca__updated__at
integer
translated__content__ca__url
string
translated__content__cs__author__id
integer
translated__content__cs__body
string
translated__content__cs__created__at
integer
translated__content__cs__description
string
translated__content__cs__state
string
translated__content__cs__title
string
translated__content__cs__type
string
translated__content__cs__updated__at
integer
translated__content__cs__url
string
translated__content__da__author__id
integer
translated__content__da__body
string
translated__content__da__created__at
integer
translated__content__da__description
string
translated__content__da__state
string
translated__content__da__title
string
translated__content__da__type
string
translated__content__da__updated__at
integer
translated__content__da__url
string
translated__content__de__author__id
integer
translated__content__de__body
string
translated__content__de__created__at
integer
translated__content__de__description
string
translated__content__de__state
string
translated__content__de__title
string
translated__content__de__type
string
translated__content__de__updated__at
integer
translated__content__de__url
string
translated__content__el__author__id
integer
translated__content__el__body
string
translated__content__el__created__at
integer
translated__content__el__description
string
translated__content__el__state
string
translated__content__el__title
string
translated__content__el__type
string
translated__content__el__updated__at
integer
translated__content__el__url
string
translated__content__en__author__id
integer
translated__content__en__body
string
translated__content__en__created__at
integer
translated__content__en__description
string
translated__content__en__state
string
translated__content__en__title
string
translated__content__en__type
string
translated__content__en__updated__at
integer
translated__content__en__url
string
translated__content__es__author__id
integer
translated__content__es__body
string
translated__content__es__created__at
integer
translated__content__es__description
string
translated__content__es__state
string
translated__content__es__title
string
translated__content__es__type
string
translated__content__es__updated__at
integer
translated__content__es__url
string
translated__content__et__author__id
integer
translated__content__et__body
string
translated__content__et__created__at
integer
translated__content__et__description
string
translated__content__et__state
string
translated__content__et__title
string
translated__content__et__type
string
translated__content__et__updated__at
integer
translated__content__et__url
string
translated__content__fi__author__id
integer
translated__content__fi__body
string
translated__content__fi__created__at
integer
translated__content__fi__description
string
translated__content__fi__state
string
translated__content__fi__title
string
translated__content__fi__type
string
translated__content__fi__updated__at
integer
translated__content__fi__url
string
translated__content__fr__author__id
integer
translated__content__fr__body
string
translated__content__fr__created__at
integer
translated__content__fr__description
string
translated__content__fr__state
string
translated__content__fr__title
string
translated__content__fr__type
string
translated__content__fr__updated__at
integer
translated__content__fr__url
string
translated__content__he__author__id
integer
translated__content__he__body
string
translated__content__he__created__at
integer
translated__content__he__description
string
translated__content__he__state
string
translated__content__he__title
string
translated__content__he__type
string
translated__content__he__updated__at
integer
translated__content__he__url
string
translated__content__hr__author__id
integer
translated__content__hr__body
string
translated__content__hr__created__at
integer
translated__content__hr__description
string
translated__content__hr__state
string
translated__content__hr__title
string
translated__content__hr__type
string
translated__content__hr__updated__at
integer
translated__content__hr__url
string
translated__content__hu__author__id
integer
translated__content__hu__body
string
translated__content__hu__created__at
integer
translated__content__hu__description
string
translated__content__hu__state
string
translated__content__hu__title
string
translated__content__hu__type
string
translated__content__hu__updated__at
integer
translated__content__hu__url
string
translated__content__id__author__id
integer
translated__content__id__body
string
translated__content__id__created__at
integer
translated__content__id__description
string
translated__content__id__state
string
translated__content__id__title
string
translated__content__id__type
string
translated__content__id__updated__at
integer
translated__content__id__url
string
translated__content__it__author__id
integer
translated__content__it__body
string
translated__content__it__created__at
integer
translated__content__it__description
string
translated__content__it__state
string
translated__content__it__title
string
translated__content__it__type
string
translated__content__it__updated__at
integer
translated__content__it__url
string
translated__content__ja__author__id
integer
translated__content__ja__body
string
translated__content__ja__created__at
integer
translated__content__ja__description
string
translated__content__ja__state
string
translated__content__ja__title
string
translated__content__ja__type
string
translated__content__ja__updated__at
integer
translated__content__ja__url
string
translated__content__ko__author__id
integer
translated__content__ko__body
string
translated__content__ko__created__at
integer
translated__content__ko__description
string
translated__content__ko__state
string
translated__content__ko__title
string
translated__content__ko__type
string
translated__content__ko__updated__at
integer
translated__content__ko__url
string
translated__content__lt__author__id
integer
translated__content__lt__body
string
translated__content__lt__created__at
integer
translated__content__lt__description
string
translated__content__lt__state
string
translated__content__lt__title
string
translated__content__lt__type
string
translated__content__lt__updated__at
integer
translated__content__lt__url
string
translated__content__lv__author__id
integer
translated__content__lv__body
string
translated__content__lv__created__at
integer
translated__content__lv__description
string
translated__content__lv__state
string
translated__content__lv__title
string
translated__content__lv__type
string
translated__content__lv__updated__at
integer
translated__content__lv__url
string
translated__content__mn__author__id
integer
translated__content__mn__body
string
translated__content__mn__created__at
integer
translated__content__mn__description
string
translated__content__mn__state
string
translated__content__mn__title
string
translated__content__mn__type
string
translated__content__mn__updated__at
integer
translated__content__mn__url
string
translated__content__nb__author__id
integer
translated__content__nb__body
string
translated__content__nb__created__at
integer
translated__content__nb__description
string
translated__content__nb__state
string
translated__content__nb__title
string
translated__content__nb__type
string
translated__content__nb__updated__at
integer
translated__content__nb__url
string
translated__content__nl__author__id
integer
translated__content__nl__body
string
translated__content__nl__created__at
integer
translated__content__nl__description
string
translated__content__nl__state
string
translated__content__nl__title
string
translated__content__nl__type
string
translated__content__nl__updated__at
integer
translated__content__nl__url
string
translated__content__pl__author__id
integer
translated__content__pl__body
string
translated__content__pl__created__at
integer
translated__content__pl__description
string
translated__content__pl__state
string
translated__content__pl__title
string
translated__content__pl__type
string
translated__content__pl__updated__at
integer
translated__content__pl__url
string
translated__content__pt__BR__author__id
integer
translated__content__pt__BR__body
string
translated__content__pt__BR__created__at
integer
translated__content__pt__BR__description
string
translated__content__pt__BR__state
string
translated__content__pt__BR__title
string
translated__content__pt__BR__type
string
translated__content__pt__BR__updated__at
integer
translated__content__pt__BR__url
string
translated__content__pt__author__id
integer
translated__content__pt__body
string
translated__content__pt__created__at
integer
translated__content__pt__description
string
translated__content__pt__state
string
translated__content__pt__title
string
translated__content__pt__type
string
translated__content__pt__updated__at
integer
translated__content__pt__url
string
translated__content__ro__author__id
integer
translated__content__ro__body
string
translated__content__ro__created__at
integer
translated__content__ro__description
string
translated__content__ro__state
string
translated__content__ro__title
string
translated__content__ro__type
string
translated__content__ro__updated__at
integer
translated__content__ro__url
string
translated__content__ru__author__id
integer
translated__content__ru__body
string
translated__content__ru__created__at
integer
translated__content__ru__description
string
translated__content__ru__state
string
translated__content__ru__title
string
translated__content__ru__type
string
translated__content__ru__updated__at
integer
translated__content__ru__url
string
translated__content__sl__author__id
integer
translated__content__sl__body
string
translated__content__sl__created__at
integer
translated__content__sl__description
string
translated__content__sl__state
string
translated__content__sl__title
string
translated__content__sl__type
string
translated__content__sl__updated__at
integer
translated__content__sl__url
string
translated__content__sr__author__id
integer
translated__content__sr__body
string
translated__content__sr__created__at
integer
translated__content__sr__description
string
translated__content__sr__state
string
translated__content__sr__title
string
translated__content__sr__type
string
translated__content__sr__updated__at
integer
translated__content__sr__url
string
translated__content__sv__author__id
integer
translated__content__sv__body
string
translated__content__sv__created__at
integer
translated__content__sv__description
string
translated__content__sv__state
string
translated__content__sv__title
string
translated__content__sv__type
string
translated__content__sv__updated__at
integer
translated__content__sv__url
string
translated__content__tr__author__id
integer
translated__content__tr__body
string
translated__content__tr__created__at
integer
translated__content__tr__description
string
translated__content__tr__state
string
translated__content__tr__title
string
translated__content__tr__type
string
translated__content__tr__updated__at
integer
translated__content__tr__url
string
translated__content__type
string
translated__content__vi__author__id
integer
translated__content__vi__body
string
translated__content__vi__created__at
integer
translated__content__vi__description
string
translated__content__vi__state
string
translated__content__vi__title
string
translated__content__vi__type
string
translated__content__vi__updated__at
integer
translated__content__vi__url
string
translated__content__zh__CN__author__id
integer
translated__content__zh__CN__body
string
translated__content__zh__CN__created__at
integer
translated__content__zh__CN__description
string
translated__content__zh__CN__state
string
translated__content__zh__CN__title
string
translated__content__zh__CN__type
string
translated__content__zh__CN__updated__at
integer
translated__content__zh__CN__url
string
translated__content__zh__TW__author__id
integer
translated__content__zh__TW__body
string
translated__content__zh__TW__created__at
integer
translated__content__zh__TW__description
string
translated__content__zh__TW__state
string
translated__content__zh__TW__title
string
translated__content__zh__TW__type
string
translated__content__zh__TW__updated__at
integer
translated__content__zh__TW__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_CREATE_A_COLLECTION

You can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`

Action Parameters

description
string
help_center_id
integer
name
stringRequired
parent_id
string
translated__content__ar__description
string
translated__content__ar__name
string
translated__content__ar__type
string
translated__content__bg__description
string
translated__content__bg__name
string
translated__content__bg__type
string
translated__content__bs__description
string
translated__content__bs__name
string
translated__content__bs__type
string
translated__content__ca__description
string
translated__content__ca__name
string
translated__content__ca__type
string
translated__content__cs__description
string
translated__content__cs__name
string
translated__content__cs__type
string
translated__content__da__description
string
translated__content__da__name
string
translated__content__da__type
string
translated__content__de__description
string
translated__content__de__name
string
translated__content__de__type
string
translated__content__el__description
string
translated__content__el__name
string
translated__content__el__type
string
translated__content__en__description
string
translated__content__en__name
string
translated__content__en__type
string
translated__content__es__description
string
translated__content__es__name
string
translated__content__es__type
string
translated__content__et__description
string
translated__content__et__name
string
translated__content__et__type
string
translated__content__fi__description
string
translated__content__fi__name
string
translated__content__fi__type
string
translated__content__fr__description
string
translated__content__fr__name
string
translated__content__fr__type
string
translated__content__he__description
string
translated__content__he__name
string
translated__content__he__type
string
translated__content__hr__description
string
translated__content__hr__name
string
translated__content__hr__type
string
translated__content__hu__description
string
translated__content__hu__name
string
translated__content__hu__type
string
translated__content__id__description
string
translated__content__id__name
string
translated__content__id__type
string
translated__content__it__description
string
translated__content__it__name
string
translated__content__it__type
string
translated__content__ja__description
string
translated__content__ja__name
string
translated__content__ja__type
string
translated__content__ko__description
string
translated__content__ko__name
string
translated__content__ko__type
string
translated__content__lt__description
string
translated__content__lt__name
string
translated__content__lt__type
string
translated__content__lv__description
string
translated__content__lv__name
string
translated__content__lv__type
string
translated__content__mn__description
string
translated__content__mn__name
string
translated__content__mn__type
string
translated__content__nb__description
string
translated__content__nb__name
string
translated__content__nb__type
string
translated__content__nl__description
string
translated__content__nl__name
string
translated__content__nl__type
string
translated__content__pl__description
string
translated__content__pl__name
string
translated__content__pl__type
string
translated__content__pt__BR__description
string
translated__content__pt__BR__name
string
translated__content__pt__BR__type
string
translated__content__pt__description
string
translated__content__pt__name
string
translated__content__pt__type
string
translated__content__ro__description
string
translated__content__ro__name
string
translated__content__ro__type
string
translated__content__ru__description
string
translated__content__ru__name
string
translated__content__ru__type
string
translated__content__sl__description
string
translated__content__sl__name
string
translated__content__sl__type
string
translated__content__sr__description
string
translated__content__sr__name
string
translated__content__sr__type
string
translated__content__sv__description
string
translated__content__sv__name
string
translated__content__sv__type
string
translated__content__tr__description
string
translated__content__tr__name
string
translated__content__tr__type
string
translated__content__type
string
translated__content__vi__description
string
translated__content__vi__name
string
translated__content__vi__type
string
translated__content__zh__CN__description
string
translated__content__zh__CN__name
string
translated__content__zh__CN__type
string
translated__content__zh__TW__description
string
translated__content__zh__TW__name
string
translated__content__zh__TW__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_CREATE_A_NOTE

You can add a note to a single contact.

Action Parameters

admin_id
string
body
stringRequired
contact_id
string
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_CREATE_OR_UPDATE_A_COMPANY

You can create or update a company. companies will be only visible in intercom when there is at least one associated user. companies are looked up via `company id` in a `post` request, if not found via `company id`, the new company will be created, if found, that company will be updated. {% admonition type="attention" name="using `company id`" %} you can set a unique `company id` value when creating a company. however, it is not possible to update `company id`. be sure to set a unique value once upon creation of the company. {% /admonition %}

Action Parameters

company_id
string
custom_attributes
object
industry
string
monthly_spend
integer
name
string
plan
string
remote_created_at
integer
size
integer
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_DELETE_AN_ARTICLE

You can delete a single article by making a delete request to `https://api.intercom.io/articles/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_DELETE_A_COLLECTION

You can delete a single collection by making a delete request to `https://api.intercom.io/collections/<id>`.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_DELETE_A_COMPANY

You can delete a single company.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_DELETE_A_CONTACT

You can delete a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_DETACH_A_CONTACT_FROM_A_COMPANY

You can detach a company from a single contact.

Action Parameters

contact_id
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_GET_A_CONTACT

You can fetch the details of a single contact.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_IDENTIFY_AN_ADMIN

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > 🚧 single sign on > > if you are building a custom "log in with intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_ACTIVITY_LOGS

You can get a log of activities by all admins in an app.

Action Parameters

created_at_after
stringRequired
created_at_before
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_ADMINS

You can fetch a list of admins for a given workspace.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_ARTICLES

You can fetch a list of all articles by making a get request to `https://api.intercom.io/articles`. > 📘 how are the articles sorted and ordered? > > articles will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated articles first.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_COLLECTIONS

You can fetch a list of all collections by making a get request to `https://api.intercom.io/help center/collections`. collections will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated collections first.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_COMPANIES

You can list companies. the company list is sorted by the `last request at` field and by default is ordered descending, most recently requested first. note that the api does not include companies who have no associated users in list responses. when using the companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 companies that can be returned. if you need to list or iterate on more than 10,000 companies, please use the [scroll api](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="pagination" %} you can use pagination to limit the number of results returned. the default is `20` results per page. see the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting after` param. {% /admonition %}

Action Parameters

order
string
page
integer
per_page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: INTERCOM_LIST_ALL_HELP_CENTERS

You can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired