Skip to main content

Intercom

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Airbyte Connector
Connector Version:
0.7.0(Last updated 2 days ago)
CDK Version:
4.6.1
Sync Success Rate:
Usage Rate:

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
  • Start date - 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.

Setup guide​

Set up Intercom​

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.

  1. Log in to your Intercom account and navigate to the Developer Hub.
  2. Click Your apps in the top-right corner, then click New app.
  3. Choose an App name, select your Workspace from the dropdown, and click Create app.
  4. 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.
  5. 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​

For Airbyte Cloud:​

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Intercom from the Source type dropdown.
  4. Enter a name for the Intercom connector.
  5. To authenticate:

For Airbyte Open Source:​

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Intercom from the Source type dropdown.
  4. Enter a name for the Intercom connector.
  • 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.
  1. 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.
  2. 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:

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

Changelog​

Expand to review
VersionDatePull RequestSubject
0.7.02024-08-2944911Migrate to CDK v4
0.6.212024-08-2444672Update dependencies
0.6.202024-08-1744296Update dependencies
0.6.192024-08-1243878Update dependencies
0.6.182024-08-1043500Update dependencies
0.6.172024-08-0343276Update dependencies
0.6.162024-07-2942094Use latest CDK, raise config error on Active subscription needed error and transient errors for Companies stream.
0.6.152024-07-2742654Update dependencies
0.6.142024-07-2042262Update dependencies
0.6.132024-07-1341712Update dependencies
0.6.122024-07-1041356Update dependencies
0.6.112024-07-0941112Update dependencies
0.6.102024-07-0640878Update dependencies
0.6.92024-06-2540428Update dependencies
0.6.82024-06-2239951Update dependencies
0.6.72024-06-0639286[autopull] Upgrade base image to v1.2.2
0.6.62024-05-2438626Add step granularity for activity logs stream
0.6.52024-04-1936644Updating to 0.80.0 CDK
0.6.42024-04-1236644Schema descriptions
0.6.32024-03-2336414Fixed pagination regression bug for conversations stream
0.6.22024-03-2236277Fixed the bug for conversations stream failed due to 404 - User Not Found, when the 2.10 API version is used
0.6.12024-03-1836232Fixed the bug caused the regression when setting the Intercom-Version header, updated the source to use the latest CDK version
0.6.02024-02-1235176Update the connector to use 2.10 API version
0.5.12024-02-1235148Manage dependencies with Poetry
0.5.02024-02-0935063Add missing fields for mutiple streams
0.4.02024-01-1133882Add new stream Activity Logs
0.3.22023-12-0733223Ignore 404 error for Conversation Parts
0.3.12023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
0.3.02023-05-2529598Update custom components to make them compatible with latest cdk version, simplify logic, update schemas
0.2.12023-05-2526571Remove authSpecification from spec.json in favour of advancedAuth
0.2.02023-04-0523013Migrated to Low-code (YAML Frramework)
0.1.332023-03-2022980Specified date formatting in specification
0.1.322023-02-2722095Extended Contacts schema adding opted_out_subscription_types property
0.1.312023-02-1723152Add TypeTransformer to stream companies
0.1.302023-01-2722010Set AvailabilityStrategy for streams explicitly to None
0.1.292022-10-3118681Define correct version for airbyte-cdk~=0.2
0.1.282022-10-2018216Use airbyte-cdk~=0.2.0 with SQLite caching
0.1.272022-08-2817326Migrate to per-stream states
0.1.262022-08-1816540Fix JSON schema
0.1.252022-08-1815681Update Intercom API to v 2.5
0.1.242022-07-2114924Remove additionalProperties field from schemas
0.1.232022-07-1914830Added checkpoint_interval for Incremental streams
0.1.222022-07-0914554Fixed conversation_parts stream schema definition
0.1.212022-07-0514403Refactored Conversations, Conversation Parts, Company Segments to increase performance
0.1.202022-06-2414099Extended Contacts stream schema with sms_consent,unsubscribe_from_sms properties
0.1.192022-05-2513204Fixed conversation_parts stream schema definition
0.1.182022-05-0412482Update input configuration copy
0.1.172022-04-2912374Fixed filtering of conversation_parts
0.1.162022-03-2311206Added conversation_id field to conversation_part records
0.1.152022-03-2211176Correct check_connection URL
0.1.142022-03-1611208Improve 'conversations' incremental sync speed
0.1.132022-01-149513Added handling of scroll param when it expired
0.1.122021-12-148429Updated fields and descriptions
0.1.112021-12-138685Remove time.sleep for rate limit
0.1.102021-12-108637Fix 'conversations' order and sorting. Correction of the companies stream
0.1.92021-12-038395Fix backoff of 'companies' stream
0.1.82021-11-097060Added oauth support
0.1.72021-11-087499Remove base-python dependencies
0.1.62021-10-076879Corrected pagination for contacts
0.1.52021-09-286082Corrected android_last_seen_at field data type in schemas
0.1.42021-09-206087Corrected updated_at field data type in schemas
0.1.32021-09-085908Corrected timestamp and arrays in schemas
0.1.22021-08-195531Corrected pagination
0.1.12021-07-315123Corrected rate limit
0.1.02021-07-194676Release Intercom CDK Connector
Was this page helpful?