Intercom is an industry-leading, real-time business messaging platform, that allows you to bring together and manage all your customer life cycle activities on a single platform.

This document guides you in setting up Intercom as a source in RudderStack. Once configured, RudderStack automatically ingests your Intercom data and routes it to your specified data warehouse destination.

This source supports Intercom API v2.1 and above.
All the Cloud Extract sources support sending data only to a data warehouse destination.

Getting started

To set up Intercom as a source in RudderStack, follow these steps:

  1. Log into your RudderStack dashboard.
  2. Go to Sources > New source > Cloud Extract and select Intercom from the list of sources.
  3. Assign a name to your source and click Continue.

Connection settings

Next, configure the following dashboard settings:

Configuring Intercom
  • Authenticate RudderStack with Intercom by clicking the Connect with Intercom button.
  • Start Date: Enter the date from which RudderStack should ingest the Intercom data. RudderStack will not replicate any data before this date.

Destination settings

The following settings specify how RudderStack sends the data ingested from Intercom to the connected warehouse destination:

  • Table prefix: RudderStack uses this prefix to create a table in your data warehouse and loads all your Intercom data into it.
  • Schedule Settings: RudderStack gives you three options to ingest the data from Intercom:
    • Basic: Runs the syncs at the specified time interval.
    • CRON: Runs the syncs based on the user-defined CRON expression.
    • Manual: You are required to run the syncs manually.
For more information on the schedule types, refer to the Common Settings guide.

Selecting the data to import

You can choose the Intercom data that you want to ingest by selecting the required resources.

Selecting the data to import

The below table mentions the sync types supported by the Intercom resources while syncing data to your warehouse destination:

ResourceSync typePrimary keyIntercom API endpoint
adminsFull Refreshid/admins
companiesIncrementalid/companies/scroll
company segmentsIncrementalid/companies/<id>/segments
company attributesFull Refreshname/data_attributes?model=company
conversationsIncrementalid/conversations
conversation partsIncrementalid/conversations/<id>
contactsIncrementalid/contacts
contact attributesFull Refreshname/data_attributes?model=contact
segmentsIncrementalid/segments
tagsFull Refreshname/tags
teamsFull Refreshname/teams
For more information on the Full Refresh and Incremental sync modes, refer to the Common Settings guide.
Any resource that supports the Incremental sync mode also supports Full Refresh, by default. To sync your data using the Full Refresh mode in such cases, you need to contact the RudderStack team.

Intercom is now configured as a source. RudderStack will start ingesting data from Intercom as per your specified schedule and frequency.

You can further connect this source to your data warehouse by clicking the Add Destination button, as shown:

Adding a destination
Use the Use Existing Destination option if you have an already-configured data warehouse destination in RudderStack. To configure a data warehouse destination from scratch, select the Create New Destination button.

Troubleshooting

Sync errors for older Intercom API versions

For Intercom versions less than 2.1, data syncs to the warehouse destination will fail and throw an error. This is because many Intercom resources are not supported by the older API versions.

In such a scenario, it is highly recommended to updated your Intercom API.

For more information on updating your Intercom API version, refer to this Intercom support page.

FAQ

Is it possible to have multiple Cloud Extract sources writing to the same schema?

Yes, it is.

RudderStack associates a table prefix for every Cloud Extract source writing to a warehouse schema. This way, multiple Cloud Extract sources can write to the same schema with different table prefixes.

My data syncs are failing. What should I do?

If your data syncs are failing, verify if your Intercom version is 2.1 or above. For versions less than 2.1, data syncs to the warehouse destination will fail. This is because many Intercom resources are not supported by the older API versions. In this scenario, you will need to update your Intercom API.

For more information on updating your Intercom API version, refer to the Intercom support page.

If you are using Intercom 2.1 or above and are facing this issue, you can contact us or get in touch with us in our Slack community.


Contact us

For more information on the topics covered on this page, email us or start a conversation in our Slack community.