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.Create the integration
In Nango (free signup), go to Integrations -> Configure New Integration -> Intercom.
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.
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:Or fetch credentials with the Node SDK or API.β
Youβre connected! Check the Logs tab in Nango to inspect requests.
- cURL
- Node
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.-
How to register your own Intercom OAuth app
Register an OAuth app with Intercom and obtain credentials to connect it to Nango -
How do I link my Intercom account?
Learn how to authenticate with Intercom and link your account
π§© Pre-built syncs & actions for Intercom
Enable them in your dashboard. Extend and customize to fit your needs.Admins
| Function name | Description | Type | Source code |
|---|---|---|---|
get-admin | Retrieve an admin by ID. | Action | π Github |
list-admins | List all admins in the workspace. | Action | π Github |
Articles
| Function name | Description | Type | Source code |
|---|---|---|---|
create-article | Create a Help Center article. | Action | π Github |
get-article | Retrieve a Help Center article by ID. | Action | π Github |
list-articles | List Help Center articles with pagination. | Action | π Github |
update-article | Update a Help Center article | Action | π Github |
Companies
| Function name | Description | Type | Source code |
|---|---|---|---|
create-company | Create a company in Intercom. | Action | π Github |
delete-company | Delete a company by ID. | Action | π Github |
get-company | Retrieve a company by ID. | Action | π Github |
list-companies | List companies with cursor-based pagination. | Action | π Github |
list-company-contacts | List contacts attached to a company. | Action | π Github |
update-company | Update mutable fields on an existing company | Action | π Github |
Contacts
| Function name | Description | Type | Source code |
|---|---|---|---|
attach-contact-to-company | Associate a contact with a company. | Action | π Github |
create-contact | Create a contact (user or lead) in Intercom. | Action | π Github |
delete-contact | Delete a contact by ID | Action | π Github |
detach-contact-from-company | Remove a contactβs association with a company. | Action | π Github |
get-contact | Retrieve a contact by ID. | Action | π Github |
list-contacts | List contacts with cursor-based pagination. | Action | π Github |
merge-contacts | Merge a lead into a user contact. | Action | π Github |
search-contacts | Search contacts with a structured filter query. | Action | π Github |
update-contact | Update mutable fields on an existing contact. | Action | π Github |
Conversations
| Function name | Description | Type | Source code |
|---|---|---|---|
close-conversation | Close an open conversation | Action | π Github |
create-conversation | Start a new conversation. | Action | π Github |
get-conversation | Retrieve a conversation by ID. | Action | π Github |
list-conversations | List conversations with cursor-based pagination. | Action | π Github |
reopen-conversation | Reopen a closed conversation. | Action | π Github |
reply-to-conversation | Add a reply or internal note to a conversation | Action | π Github |
search-conversations | Search conversations with a structured filter query | Action | π Github |
snooze-conversation | Snooze a conversation until a given timestamp. | Action | π Github |
untag-conversation | Remove a tag from a conversation | Action | π Github |
update-conversation | Update mutable properties on a conversation such as custom attributes or read status | Action | π Github |
Help Center
| Function name | Description | Type | Source code |
|---|---|---|---|
list-help-center-collections | List top-level Help Center collections. | Action | π Github |
Messages
| Function name | Description | Type | Source code |
|---|---|---|---|
send-message | Send an outbound message to a contact. | Action | π Github |
Notes
| Function name | Description | Type | Source code |
|---|---|---|---|
create-note | Add an internal note to a contact | Action | π Github |
list-notes | List internal notes for a contact. | Action | π Github |
Tags
| Function name | Description | Type | Source code |
|---|---|---|---|
create-tag | Create a new tag | Action | π Github |
list-tags | List all tags in the workspace. | Action | π Github |
tag-companies | Apply a tag to one or more companies | Action | π Github |
tag-contacts | Apply a tag to one or more contacts | Action | π Github |
tag-conversation | Apply a tag to a conversation. | Action | π Github |
untag-contacts | Remove a tag from one or more contacts | Action | π Github |
Others
| Function name | Description | Type | Source code |
|---|---|---|---|
delete-article | Delete a Help Center article | Action | π Github |
admins | Sync admin users from Intercom | Sync | π Github |
articles | Sync Help Center articles from Intercom | Sync | π Github |
companies | Sync company records from Intercom. | Sync | π Github |
contacts | Sync contacts (users and leads) from Intercom. | Sync | π Github |
conversation-parts | Sync conversation messages (parts) from Intercom | Sync | π Github |
conversations | Sync conversations from Intercom | Sync | π Github |
help-center-collections | Sync Help Center collections and sections from Intercom. | Sync | π Github |
segments | Sync contact segments from Intercom. | Sync | π Github |
tags | Sync tags from Intercom | Sync | π Github |