Intercom
This page contains the setup guide and reference information for the Intercom source connector.
Prerequisites
- Access to an Intercom account with the data you want to replicate
Setup guide
Obtain an Intercom access token (Airbyte Open Source)
To authenticate the connector in Airbyte Open Source, you will need to obtain an access token. You can follow the setup steps below to create an Intercom app and generate the token. For more information on Intercom's authentication flow, refer to the official documentation.
- Log in to your Intercom account and navigate to the Developer Hub.
- Click Your apps in the top-right corner, then click New app.
- Choose an App name, select your Workspace from the dropdown, and click Create app.
- To set the appropriate permissions, from the Authentication tab, click Edit in the top right corner and check the permissions you want to grant to the app. We recommend only granting read permissions (not write). Click Save when you are finished.
- Under the Access token header, you will be prompted to regenerate your access token. Follow the instructions to do so, and copy the new token.
Set up the Intercom connector in Airbyte
- Log in to your Airbyte Cloud or Airbyte Open Source account.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- Find and select Intercom from the list of available sources.
- Enter a Source name to help you identify this source.
- To authenticate:
- For Airbyte Cloud, click Authenticate your Intercom account. When the pop-up appears, select the appropriate workspace from the dropdown and click Authorize access.
- For Airbyte Open Source, enter your access token to authenticate your account.
- For Start date, use the provided datepicker or enter a UTC date and time programmatically in the format
YYYY-MM-DDTHH:mm:ssZ
. The data added on and after this date will be replicated. - Click Set up source and wait for the tests to complete.
Supported sync modes
The Intercom source connector supports the following sync modes:
- Full Refresh
- Incremental
Supported streams
The Intercom source connector supports the following streams:
- Admins (Full table)
- Companies (Incremental)
- Company Segments (Incremental)
- Conversations (Incremental)
- Conversation Parts (Incremental)
- Data Attributes (Full table)
- Customer Attributes (Full table)
- Company Attributes (Full table)
- Contacts (Incremental)
- Segments (Incremental)
- Tags (Full table)
- Teams (Full table)
Performance considerations
The connector is restricted by normal Intercom request limitations.
The Intercom connector should not run into Intercom API limitations under normal usage. Create an issue if you see any rate limit issues that are not automatically retried successfully.
Reference
Config fields reference
Field
Type
Property name
string
start_date
string
access_token
string
client_id
string
client_secret
integer
activity_logs_time_step