Intercom
Learn how to use Intercom with Composio
Overview
Enum
INTERCOM
Description
A messaging platform that allows businesses to communicate with prospective and existing customers within their app, on their website, through social media, or via email.
Authentication Details
OAUTH2
Actions
INTERCOM_LIST_ALL_ADMINS
You can fetch a list of admins for a given workspace.
Action Parameters
Action Response
INTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACT
You can fetch a list of subscription types that are attached to a contact. these can be subscriptions that a user has ‘opted-in’ to or has ‘opted-out’ from, depending on the subscription type. this will return a list of subscription type objects that the contact is associated with. the data property will show a combined list of: 1.opt-out subscription types that the user has opted-out from. 2.opt-in subscription types that the user has opted-in to receiving.
Action Parameters
Action Response
INTERCOM_RETRIEVE_AN_ADMIN
You can retrieve the details of a single admin.
Action Parameters
Action Response
INTERCOM_LIST_ALL_ACTIVITY_LOGS
You can get a log of activities by all admins in an app.
Action Parameters
Action Response
INTERCOM_UPDATE_A_COMPANY
You can update a single company using the intercom provisioned id. {\% admonition type=attention name=using company id``_\%} when updating a company it is not possible to update company id. this can only be set once upon creation of the company. {\% /admonition_\%}
Action Parameters
Action Response
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
INTERCOM_SCROLL_OVER_ALL_COMPANIES
The list all companies functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. the scroll api provides an efficient mechanism for iterating over all companies in a dataset. - each app can only have 1 scroll open at a time. you’ll get an error message if you try to have more than one open per app. you can get the first page of companies by simply sending a get request to the scroll endpoint. for subsequent requests you will need to use the scroll parameter from the response type=“danger” name=“scroll network timeouts”. since scroll is often used on large datasets network errors such as timeouts can be encountered. when this occurs you will see a http 500 error with the following message: “request failed due to an internal network error. please restart the scroll operation.” if this happens, you will need to restart your scroll query.
Action Parameters
Action Response
INTERCOM_RETRIEVE_A_COMPANY_BY_ID
You can fetch a single company.
Action Parameters
Action Response
INTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACT
You can remove a specific subscription from a contact. this will return a subscription type model for the subscription type that was removed from the contact.
Action Parameters
Action Response
INTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACT
You can fetch a list of companies that are associated to a contact.
Action Parameters
Action Response
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
INTERCOM_DELETE_AN_ARTICLE
You can delete a single article by making a delete request to https://api.intercom.io/articles/.
Action Parameters
Action Response
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
Action Response
INTERCOM_SEARCH_FOR_ARTICLES
You can search for articles by making a get request to https://api.intercom.io/articles/search.
Action Parameters
Action Response
INTERCOM_UPDATE_A_CONTACT
You can update an existing contact (ie. user or lead).
Action Parameters
Action Response
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
Action Response
INTERCOM_UPDATE_AN_ARTICLE
You can update the details of a single article by making a put request to https://api.intercom.io/articles/.
Action Parameters
Action Response
INTERCOM_RETRIEVE_AN_ARTICLE
You can fetch the details of a single article by making a get request to https://api.intercom.io/articles/.
Action Parameters
Action Response
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
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
Action Response
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
INTERCOM_GET_A_CONTACT
You can fetch the details of a single contact.
Action Parameters
Action Response
INTERCOM_LIST_ATTACHED_CONTACTS
You can fetch a list of all contacts that belong to a company.
Action Parameters
Action Response
INTERCOM_DETACH_A_CONTACT_FROM_A_COMPANY
You can detach a company from a single contact.
Action Parameters
Action Response
INTERCOM_DELETE_A_COLLECTION
You can delete a single collection by making a delete request to https://api.intercom.io/collections/.
Action Parameters
Action Response
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
Action Response
INTERCOM_REMOVE_TAG_FROM_A_CONTACT
You can remove tag from a specific contact. this will return a tag object for the tag that was removed from the contact.
Action Parameters
Action Response
INTERCOM_DELETE_A_COMPANY
You can delete a single company.
Action Parameters
Action Response
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACT
You can fetch a list of segments that are associated to a contact.
Action Parameters
Action Response
INTERCOM_UPDATE_A_COLLECTION
You can update the details of a single collection by making a put request to https://api.intercom.io/collections/.
Action Parameters
Action Response
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. {\% 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 for more details on how to use the starting after param. {\% /admonition_\%}
Action Parameters
Action Response
INTERCOM_ATTACH_A_CONTACT_TO_A_COMPANY
You can attach a company to a single contact.
Action Parameters
Action Response
INTERCOM_RETRIEVE_A_HELP_CENTER
You can fetch the details of a single help center by making a get request to https://api.intercom.io/help center/help center/.
Action Parameters
Action Response
INTERCOM_LIST_ALL_NOTES
You can fetch a list of notes that are associated to a contact.
Action Parameters
Action Response
INTERCOM_CREATE_AN_ARTICLE
You can create a new article by making a post request to https://api.intercom.io/articles.
Action Parameters
Action Response
INTERCOM_DELETE_A_CONTACT
You can delete a single contact.
Action Parameters
Action Response
INTERCOM_MERGE_A_LEAD_AND_A_USER
You can merge a contact with a role of lead into a contact with a role of user.
Action Parameters
Action Response
INTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACT
You can fetch a list of all tags that are attached to a specific contact.
Action Parameters
Action Response
INTERCOM_CREATE_A_NOTE
You can add a note to a single contact.
Action Parameters
Action Response
INTERCOM_SET_AN_ADMIN_TO_AWAY
You can set an admin as away for the inbox.
Action Parameters
Action Response
INTERCOM_RETRIEVE_A_COLLECTION
You can fetch the details of a single collection by making a get request to https://api.intercom.io/help center/collections/.
Action Parameters
Action Response
INTERCOM_RETRIEVE_COMPANIES
You can fetch a single company by passing in company id or name. https://api.intercom.io/companies?name={name} `https://api.intercom.io/companies?company id=`{company_id} you can fetch all companies and filter by segment id or tag id as a query parameter. https://api.intercom.io/companies?tag id={tag_id} `https://api.intercom.io/companies?segment id=`{segment_id}
Action Parameters
Action Response
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIES
You can fetch a list of all segments that belong to a company.
Action Parameters
Action Response