Intercom Connector

Last updated
Save as PDF

Version 3

Intro

Intercom is a platform used to integrate customer messaging apps for sales, marketing and support connected on one platform. Use the Domo Intercom connector to receive details about conversations, leads, users and more. To learn more about the Intercom API, visit their page (https://developers.intercom.com/inte...ence/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 Adding a DataSet Using a Data Connector.

Prerequisites

To connect to your Intercom account and create a DataSet, you must have an Intercom access token. For information about obtaining an access token, see https://developers.intercom.com/docs...-access-tokens. Note that some reports require your access token to have "extended scope."

Connecting to Your Intercom Account

This section enumerates the options in the Credentials and Details panes in the Intercom Connector page. The components of the other panes in 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.

Credentials Pane

This pane contains fields for entering credentials to connect to your Intercom account. The following table describes what is needed for each field:

Field	Description
Access Token	Enter your Intercom access token. For more information, see "Prerequisites," above.

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.

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.

Description

Report

Select the Intercom report you want to run. The following reports are available:

All Conversations	Retrieves a list of conversations between assigned and/or unassigned users.
Conversations by Admin	Retrieves a list of conversations for a given admin.
Conversation Details	Returns details for conversations between users for a given admin. Note that the maximum number of conversation parts that can be returned is 500.
Events	Retrieves all events or activities submitted by the user, along with the occurrence of those events.
Leads (Scroll API)	Returns all of the leads or contacts for the account. Leads are useful for representing logged-out users in the application.
Lead by Lead ID	Retrieves leads with a given lead ID. Does not use the Scroll API to retrieve records. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.
Notes by User	Retrieves specific notes according to selected user associated with intercom application. Does not use the Scroll API to retrieve records. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.
Users (Scroll API)	Retrieves a list of all users.
Users by Username	Retrieves a list of users with a given username. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.
Users by Company	Returns users with a given company ID. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.
Users by Tag	Returns users with a given tag. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.
Users by Segments	Returns users for a given segment. Note: The maximum number of records returned is 10,000. If you have more than 10,000 Intercom leads and require filtering, please use the Leads report and apply filters using Domo's ETL tools or page and card level filters.

Event Type

Select whether to pull user or lead events.

Conversation Admin Type

Select the type of conversation admin to pull data for.

All	Retrieves all conversations for both assigned and unassigned users.
Specific	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.
Unassigned	Retrieves unassigned conversations.

Company

Select the company you want to retrieve data for.

Segments

Select the segments you want to retrieve data for.

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.

FAQs

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.

Are there any API rate limits I should be aware of?

Intercom allows 83 calls per 10 seconds or roughly 500 per minute.

What kind of credentials do I need to power this connector?

Intercom requires an access token to authenticate. Be aware that some reports require that your access token include "extended access" to work. If you receive an authentication error and your key is valid, check with your Intercom administrator to get "extended access" added to your API key.