Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

πŸš€ Quickstart

Connect to Intercom with Nango and see data flow in 2 minutes.
1

Create the integration

In Nango (free signup), go to Integrations -> Configure New Integration -> Intercom.
2

Authorize Intercom

Go to Connections -> Add Test Connection -> Authorize, then log in to Intercom. Later, you’ll let your users do the same directly from your app. Nango doesn’t provide a test OAuth app for Intercom yet. You’ll need to set up your own by following these instructions. After that, make sure to add the OAuth client ID, secret, and scopes in the integration settings in Nango.
3

Call the Intercom API

Let’s make your first request to the Intercom API (fetch current admin information). Replace the placeholders below with your secret key, integration ID, and connection ID:
curl "https://api.nango.dev/proxy/me" \
  -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"
Or fetch credentials with the Node SDK or API.βœ… You’re connected! Check the Logs tab in Nango to inspect requests.
4

Implement Nango in your app

Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.

πŸ“š Intercom Integration Guides

Nango maintained guides for common use cases. Official docs: Intercom API documentation

🧩 Pre-built syncs & actions for Intercom

Enable them in your dashboard. Extend and customize to fit your needs.

Admins

Function nameDescriptionTypeSource code
get-adminRetrieve an admin by ID.ActionπŸ”— Github
list-adminsList all admins in the workspace.ActionπŸ”— Github

Articles

Function nameDescriptionTypeSource code
create-articleCreate a Help Center article.ActionπŸ”— Github
get-articleRetrieve a Help Center article by ID.ActionπŸ”— Github
list-articlesList Help Center articles with pagination.ActionπŸ”— Github
update-articleUpdate a Help Center articleActionπŸ”— Github

Companies

Function nameDescriptionTypeSource code
create-companyCreate a company in Intercom.ActionπŸ”— Github
delete-companyDelete a company by ID.ActionπŸ”— Github
get-companyRetrieve a company by ID.ActionπŸ”— Github
list-companiesList companies with cursor-based pagination.ActionπŸ”— Github
list-company-contactsList contacts attached to a company.ActionπŸ”— Github
update-companyUpdate mutable fields on an existing companyActionπŸ”— Github

Contacts

Function nameDescriptionTypeSource code
attach-contact-to-companyAssociate a contact with a company.ActionπŸ”— Github
create-contactCreate a contact (user or lead) in Intercom.ActionπŸ”— Github
delete-contactDelete a contact by IDActionπŸ”— Github
detach-contact-from-companyRemove a contact’s association with a company.ActionπŸ”— Github
get-contactRetrieve a contact by ID.ActionπŸ”— Github
list-contactsList contacts with cursor-based pagination.ActionπŸ”— Github
merge-contactsMerge a lead into a user contact.ActionπŸ”— Github
search-contactsSearch contacts with a structured filter query.ActionπŸ”— Github
update-contactUpdate mutable fields on an existing contact.ActionπŸ”— Github

Conversations

Function nameDescriptionTypeSource code
close-conversationClose an open conversationActionπŸ”— Github
create-conversationStart a new conversation.ActionπŸ”— Github
get-conversationRetrieve a conversation by ID.ActionπŸ”— Github
list-conversationsList conversations with cursor-based pagination.ActionπŸ”— Github
reopen-conversationReopen a closed conversation.ActionπŸ”— Github
reply-to-conversationAdd a reply or internal note to a conversationActionπŸ”— Github
search-conversationsSearch conversations with a structured filter queryActionπŸ”— Github
snooze-conversationSnooze a conversation until a given timestamp.ActionπŸ”— Github
untag-conversationRemove a tag from a conversationActionπŸ”— Github
update-conversationUpdate mutable properties on a conversation such as custom attributes or read statusActionπŸ”— Github

Help Center

Function nameDescriptionTypeSource code
list-help-center-collectionsList top-level Help Center collections.ActionπŸ”— Github

Messages

Function nameDescriptionTypeSource code
send-messageSend an outbound message to a contact.ActionπŸ”— Github

Notes

Function nameDescriptionTypeSource code
create-noteAdd an internal note to a contactActionπŸ”— Github
list-notesList internal notes for a contact.ActionπŸ”— Github

Tags

Function nameDescriptionTypeSource code
create-tagCreate a new tagActionπŸ”— Github
list-tagsList all tags in the workspace.ActionπŸ”— Github
tag-companiesApply a tag to one or more companiesActionπŸ”— Github
tag-contactsApply a tag to one or more contactsActionπŸ”— Github
tag-conversationApply a tag to a conversation.ActionπŸ”— Github
untag-contactsRemove a tag from one or more contactsActionπŸ”— Github

Others

Function nameDescriptionTypeSource code
delete-articleDelete a Help Center articleActionπŸ”— Github
adminsSync admin users from IntercomSyncπŸ”— Github
articlesSync Help Center articles from IntercomSyncπŸ”— Github
companiesSync company records from Intercom.SyncπŸ”— Github
contactsSync contacts (users and leads) from Intercom.SyncπŸ”— Github
conversation-partsSync conversation messages (parts) from IntercomSyncπŸ”— Github
conversationsSync conversations from IntercomSyncπŸ”— Github
help-center-collectionsSync Help Center collections and sections from Intercom.SyncπŸ”— Github
segmentsSync contact segments from Intercom.SyncπŸ”— Github
tagsSync tags from IntercomSyncπŸ”— Github