> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom OAuth Connector

## Intro

Intercom OAuth is a platform used to integrate customer messaging apps for sales, marketing, and support connected on one platform. To learn more about the Intercom API, visit their page ([https://developers.intercom.com/inte...ence/reference](https://developers.intercom.com/intercom-api-reference/reference "https://developers.intercom.com/intercom-api-reference/reference")).

You connect to your Intercom account in the Data Center. This topic discusses the fields and menus that are specific to the Intercom connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Prerequisites

To connect to your Intercom account and create a DataSet, you must have credentials. For information on setting up OAuth, see [Setting up OAuth (intercom.com)](https://developers.intercom.com/building-apps/docs/setting-up-oauth)

## Connecting to Your Intercom OAuth Account

This section enumerates the options in the **Credentials** and **Details** panes on the Intercom Connector page. The components of the other panes on this page, **Scheduling,** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

The Domo Intercom OAuth Connector uses OAuth to connect, you have to enter your credentials within Domo. Click **Connect** (or select **Add Account** if you have existing Intercom accounts in Domo) to open the Intercom OAuth screen where you can enter your Intercom username and password. Once you have entered valid Intercom credentials, you can use the same account any time you go to create a new Intercom DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054).

<Note>
  **Note:** If you are already logged into Intercom when you connect in Domo, you are authenticated automatically when you click **Add account**. If you want to connect to an account that is different from the one you are logged into, you must first log out of Intercom.
</Note>

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the <span> Intercom </span><span /> report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1" width="410"><tbody><tr><td colspan="1" rowspan="1"> Admins </td><td colspan="1" rowspan="1"><p><span> Returns a list of admins. </span></p></td></tr><tr><td colspan="1" rowspan="1"><p> Attached </p> Companies </td><td colspan="1" rowspan="1"><p> Returns a list of companies that are associated with a contact. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Attached Contacts </p></td><td colspan="1" rowspan="1"><p> Returns a list of all the contacts that belong to a company. </p></td></tr><tr><td colspan="1" rowspan="1"> Attached Tags </td><td colspan="1" rowspan="1"><p> Returns a list of tags that are associated with a contact. </p></td></tr><tr><td colspan="1" rowspan="1"> Companies </td><td colspan="1" rowspan="1"> Returns a list of companies. </td></tr><tr><td colspan="1" rowspan="1"> Contacts </td><td colspan="1" rowspan="1"><p> Returns a list of contacts. </p></td></tr><tr><td colspan="1" rowspan="1"> Contacts by Contact Id </td><td colspan="1" rowspan="1"><p> Returns the details of the specified contact. </p></td></tr><tr><td colspan="1" rowspan="1"> Conversations </td><td colspan="1" rowspan="1"> Retrieves a list of conversations. </td></tr><tr><td colspan="1" rowspan="1"> Conversations by Conversation Id </td><td colspan="1" rowspan="1"><p> Returns the details of a single conversation. </p></td></tr><tr><td colspan="1" rowspan="1"> Counts </td><td colspan="1" rowspan="1"><p> Returns the count of your App.. </p></td></tr><tr><td colspan="1" rowspan="1"> Notes </td><td colspan="1" rowspan="1"><p> Returns a list of notes that are associated with a contact. </p></td></tr><tr><td colspan="1" rowspan="1"> Notes by Note Id </td><td colspan="1" rowspan="1" width="258"><p> Returns the details of a single note. </p></td></tr><tr><td colspan="1" rowspan="1"> Segments </td><td colspan="1" rowspan="1"><p> Returns a list of segments. </p></td></tr><tr><td colspan="1" rowspan="1"> Tags </td><td colspan="1" rowspan="1"><p> Returns a list of Tags. </p></td></tr><tr><td colspan="1" rowspan="1"> Teams </td><td colspan="1" rowspan="1"><p> Returns a list of teams. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AI content import sources </p></td><td colspan="1" rowspan="1"><p> Returns a list of all the content import sources for a workspace. </p></td></tr><tr><td colspan="1" rowspan="1"><p> AI external pages </p></td><td colspan="1" rowspan="1"><p> Returns a list of all external pages for a workspace. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Event Type </p></td><td colspan="1" rowspan="1"><p> Select whether to pull user or lead events. </p></td></tr><tr><td colspan="1" rowspan="1"> Conversation Admin Type </td><td colspan="1" rowspan="1"> Select the type of conversation admin to pull data for. <table border="1"><tbody><tr><td colspan="1" rowspan="1"> All </td><td colspan="1" rowspan="1"> Retrieves all conversations for both assigned and unassigned users. </td></tr><tr><td colspan="1" rowspan="1"> Specific </td><td colspan="1" rowspan="1"> Retrieves all conversations for a given admin. Note that when querying conversations for a given user, Intercom carries out message matching for the user and your existing auto-messages. This will happen at most once every 15 minutes. </td></tr><tr><td colspan="1" rowspan="1"> Unassigned </td><td colspan="1" rowspan="1"> Retrieves unassigned conversations. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Company </td><td colspan="1" rowspan="1"> Select the type of company you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Segments </td><td colspan="1" rowspan="1"> Select the segments you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Tags </td><td colspan="1" rowspan="1"> Select the tags you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Users </td><td colspan="1" rowspan="1"> Select the users you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Leads </td><td colspan="1" rowspan="1"> Select the leads you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Email ID </td><td colspan="1" rowspan="1"> Enter the lead you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Admin </td><td colspan="1" rowspan="1"> Select the admin you want to retrieve data for. </td></tr><tr><td colspan="1" rowspan="1"> Option to Expand </td><td colspan="1" rowspan="1"> Select the column you want to expand. </td></tr><tr><td colspan="1" rowspan="1"> Skip Failed Conversations </td><td colspan="1" rowspan="1"> When you check this box, if the intercom fails to return details for a conversation, it will be excluded from the DataSet, and Domo will continue processing instead of failing the run. This may result in missing data. </td></tr><tr><td colspan="1" rowspan="1"> Conversation Status </td><td colspan="1" rowspan="1"> Select the conversation status you want to filter your report by. </td></tr><tr><td colspan="1" rowspan="1"> Order </td><td colspan="1" rowspan="1"> Select whether you want to sort your data by created or last updated date. </td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the Connector interface, including how to configure scheduling, retry, and update options, see

[Adding a DataSet Using a Data Connector](/s/article/360042926274).

## FAQs

<AccordionGroup>
  <Accordion title="What endpoint is the base URL for this connector?">
    The base URL for the intercom is [https://api.intercom.io](https://api.intercom.io).
  </Accordion>

  <Accordion title="Which endpoint does each report call in this connector?">
    <table border="1"><tbody><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><b> Report Name </b></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><b> Endpoint URL </b></td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Admins </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /admins </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Attached Companies </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> /companies </span></td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Attached Contacts </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /contacts </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Attached Tags </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /tags </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Companies </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /companies </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Contacts </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> /contacts </span></td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> Contacts by Contact ID </td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /contacts/{contact_id}/users </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Conversations </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /conversations </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Conversations by Conversation Id </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /conversations/{conversation_id}/users </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Counts </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /counts </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Notes </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /notes </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Notes by Note ID </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"> /notes/{note_id}/users </td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Segments </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> /segments </span></td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Tags </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> /tags </span></td></tr><tr><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> Teams </span></td><td class="wysiwyg-text-align-center" colspan="1" rowspan="1"><span> /teams </span></td></tr><tr><td colspan="1" rowspan="1"><p> AI content import sources </p></td><td colspan="1" rowspan="1"><span> /ai/content\_import\_sources </span></td></tr><tr><td colspan="1" rowspan="1"><p> AI external pages </p></td><td colspan="1" rowspan="1"><span> /ai/external\_pages </span></td></tr></tbody></table>
  </Accordion>

  <Accordion title="How often can the data be updated?">
    Datasets can be updated as often as once an hour. though this should be decreased if rate limits are encountered.
  </Accordion>

  <Accordion title="Are there any API rate limits I should be aware of?">
    Intercom allows 83 calls per 10 seconds or roughly 500 per minute.
  </Accordion>

  <Accordion title="What kind of credentials do I need to power up this Connector?">
    Intercom OAuth Connector uses OAuth to connect, so there is no need to enter credentials within Domo. Click Connect (or select Add Account if you have existing Intercom accounts in Domo) to open the Intercom OAuth screen where you can enter your Intercom username and password. Once you have entered valid Intercom credentials, you can use the same account any time you go to create a new Intercom DataSet. You can manage connector accounts in the Accounts tab in the data center.
  </Accordion>

  <Accordion title="How do I know my Intercom credentials are secure?">
    The login process uses the OAuth process, so your credentials are never seen or stored by Domo. This keeps your login secure. You can revoke Domo's access to your account at any time.
  </Accordion>
</AccordionGroup>

## Troubleshooting

* Make sure your authentication remains valid.
* Review the configuration to make sure that all required items have been selected.
* Review the Connector history for error messages.
* In rare cases, you may be requesting too much information and reaching API limitations or timeouts. If this is the case, you can review the history of the Connector run to see the error message and duration. If this is the case, you can reduce the number of accounts that are being pulled, choose a smaller number of metrics for the report that you are pulling, or reduce the timeframe that you are trying to pull.
