Skip to content

Docs/Connectors

Intercom

Intercom conversations, contacts, companies and tickets as records, and each conversation's parts (replies, notes, assignments, closes) as episodes.

The intercom connector reads a support team's Intercom workspace. It runs Airbyte's Intercom connector definition inside the SDK.

Connector name intercom
Products Records, episodes
Credentials The portal's Connect button, or an access token from an Intercom app
Definition Airbyte's source-intercom manifest, version 0.13.25 (Elastic License 2.0)
Status Preview: tested against Intercom's documented responses, not yet on a live account

What it pulls

By default: conversation, conversation_part, contact, company, ticket, admin and team. Add tag, segment, company_segment or activity_log (the admin audit log, which needs its own permission) with objects.

Episodes. One per conversation updated in the window: every part in order (customer messages, admin replies, notes, assignments, snoozes, opens and closes) with who did it.

Credentials

In Intercom, open Settings → Developer Hub, create an app for your workspace, and copy the access token under Authentication. Give the app read permissions for users and companies, conversations, tickets and admins.

Or skip the tokens: click Connect next to Intercom in the portal (Settings → Connected systems), then run datayield connect intercom --broker. The Connect button works for workspaces hosted in the US; EU and Australian workspaces are not supported yet.

Connect

bash
datayield connect intercom -o accessToken=env:INTERCOM_TOKEN

Options

Option Required Meaning
accessToken yes The app's access token. Stored as a secret.
startDate no Where the first run starts
objects no Record types to pull

New records on each run

Conversations, contacts, companies and tickets are searched by their updated time between the last successful run and now; parts are read for those conversations. Admins and teams are sent whole each run. When Intercom's rate limit runs low, the SDK slows down before it is told to.