> ## 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.

# Intercom

> Integrate your application with the Intercom API

## 🚀 Quickstart

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

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Intercom*.
  </Step>

  <Step title="Authorize Intercom">
    Go to [Connections](https://app.nango.dev/dev/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](#🧑%E2%80%8D💻-oauth-app-setup). After that, make sure to add the OAuth client ID, secret, and scopes in the integration settings in Nango.
  </Step>

  <Step title="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](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/me" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/me',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(JSON.stringify(res.data, null, 2));
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Intercom Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Intercom OAuth app](/api-integrations/intercom/how-to-register-your-own-intercom-api-oauth-app)\
  Register an OAuth app with Intercom and obtain credentials to connect it to Nango

* [How do I link my Intercom account?](/api-integrations/intercom/connect)\
  Learn how to authenticate with Intercom and link your account

Official docs: [Intercom API documentation](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis)

## 🧩 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](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/get-admin.ts)   |
| `list-admins` | List all admins in the workspace. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-admins.ts) |

### Articles

| Function name    | Description                                | Type                                         | Source code                                                                                                             |
| ---------------- | ------------------------------------------ | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `create-article` | Create a Help Center article.              | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-article.ts) |
| `get-article`    | Retrieve a Help Center article by ID.      | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/get-article.ts)    |
| `list-articles`  | List Help Center articles with pagination. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-articles.ts)  |
| `update-article` | Update a Help Center article               | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/update-article.ts) |

### Companies

| Function name           | Description                                  | Type                                         | Source code                                                                                                                    |
| ----------------------- | -------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `create-company`        | Create a company in Intercom.                | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-company.ts)        |
| `delete-company`        | Delete a company by ID.                      | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/delete-company.ts)        |
| `get-company`           | Retrieve a company by ID.                    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/get-company.ts)           |
| `list-companies`        | List companies with cursor-based pagination. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-companies.ts)        |
| `list-company-contacts` | List contacts attached to a company.         | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-company-contacts.ts) |
| `update-company`        | Update mutable fields on an existing company | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/update-company.ts)        |

### Contacts

| Function name                 | Description                                     | Type                                         | Source code                                                                                                                          |
| ----------------------------- | ----------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `attach-contact-to-company`   | Associate a contact with a company.             | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/attach-contact-to-company.ts)   |
| `create-contact`              | Create a contact (user or lead) in Intercom.    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-contact.ts)              |
| `delete-contact`              | Delete a contact by ID                          | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/delete-contact.ts)              |
| `detach-contact-from-company` | Remove a contact's association with a company.  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/detach-contact-from-company.ts) |
| `get-contact`                 | Retrieve a contact by ID.                       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/get-contact.ts)                 |
| `list-contacts`               | List contacts with cursor-based pagination.     | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-contacts.ts)               |
| `merge-contacts`              | Merge a lead into a user contact.               | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/merge-contacts.ts)              |
| `search-contacts`             | Search contacts with a structured filter query. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/search-contacts.ts)             |
| `update-contact`              | Update mutable fields on an existing contact.   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/update-contact.ts)              |

### Conversations

| Function name           | Description                                                                          | Type                                         | Source code                                                                                                                    |
| ----------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `close-conversation`    | Close an open conversation                                                           | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/close-conversation.ts)    |
| `create-conversation`   | Start a new conversation.                                                            | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-conversation.ts)   |
| `get-conversation`      | Retrieve a conversation by ID.                                                       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/get-conversation.ts)      |
| `list-conversations`    | List conversations with cursor-based pagination.                                     | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-conversations.ts)    |
| `reopen-conversation`   | Reopen a closed conversation.                                                        | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/reopen-conversation.ts)   |
| `reply-to-conversation` | Add a reply or internal note to a conversation                                       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/reply-to-conversation.ts) |
| `search-conversations`  | Search conversations with a structured filter query                                  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/search-conversations.ts)  |
| `snooze-conversation`   | Snooze a conversation until a given timestamp.                                       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/snooze-conversation.ts)   |
| `untag-conversation`    | Remove a tag from a conversation                                                     | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/untag-conversation.ts)    |
| `update-conversation`   | Update mutable properties on a conversation such as custom attributes or read status | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/update-conversation.ts)   |

### Help Center

| Function name                  | Description                             | Type                                         | Source code                                                                                                                           |
| ------------------------------ | --------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `list-help-center-collections` | List top-level Help Center collections. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-help-center-collections.ts) |

### Messages

| Function name  | Description                            | Type                                         | Source code                                                                                                           |
| -------------- | -------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `send-message` | Send an outbound message to a contact. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/send-message.ts) |

### Notes

| Function name | Description                        | Type                                         | Source code                                                                                                          |
| ------------- | ---------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `create-note` | Add an internal note to a contact  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-note.ts) |
| `list-notes`  | List internal notes for a contact. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-notes.ts)  |

### Tags

| Function name      | Description                            | Type                                         | Source code                                                                                                               |
| ------------------ | -------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `create-tag`       | Create a new tag                       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/create-tag.ts)       |
| `list-tags`        | List all tags in the workspace.        | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/list-tags.ts)        |
| `tag-companies`    | Apply a tag to one or more companies   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/tag-companies.ts)    |
| `tag-contacts`     | Apply a tag to one or more contacts    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/tag-contacts.ts)     |
| `tag-conversation` | Apply a tag to a conversation.         | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/tag-conversation.ts) |
| `untag-contacts`   | Remove a tag from one or more contacts | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/untag-contacts.ts)   |

### Others

| Function name             | Description                                              | Type                                           | Source code                                                                                                                    |
| ------------------------- | -------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `delete-article`          | Delete a Help Center article                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/actions/delete-article.ts)        |
| `admins`                  | Sync admin users from Intercom                           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/admins.ts)                  |
| `articles`                | Sync Help Center articles from Intercom                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/articles.ts)                |
| `companies`               | Sync company records from Intercom.                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/companies.ts)               |
| `contacts`                | Sync contacts (users and leads) from Intercom.           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/contacts.ts)                |
| `conversation-parts`      | Sync conversation messages (parts) from Intercom         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/conversation-parts.ts)      |
| `conversations`           | Sync conversations from Intercom                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/conversations.ts)           |
| `help-center-collections` | Sync Help Center collections and sections from Intercom. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/help-center-collections.ts) |
| `segments`                | Sync contact segments from Intercom.                     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/segments.ts)                |
| `tags`                    | Sync tags from Intercom                                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/intercom/syncs/tags.ts)                    |

***
