Intercom

Intercom is a customer messaging platform that helps businesses connect with customers through targeted, behavior-driven messages.

omniload supports Intercom as a source.

URI format

The URI format for Intercom is as follows:

intercom://?access_token=<access_token>&region=<region>

URI parameters:

• access_token: The access token is used for authentication with the Intercom API.

• region: The data region where your Intercom workspace is hosted. Valid values are us, eu, or au. Defaults to us.

The URI is used to connect to the Intercom API for extracting data.

Setting up an Intercom Integration

Intercom requires a few steps to set up an integration, please follow the guide dltHub has built here.

Once you complete the guide, you should have an access token. Let’s say your access token is dG9rOjE... and your workspace is in the US region, here’s a sample command that will copy the data from Intercom into a DuckDB database:

omniload ingest \
    --source-uri 'intercom://?access_token=dG9rOjE...&region=us' \
    --source-table 'contacts' \
    --dest-uri duckdb:///intercom.duckdb \
    --dest-table 'intercom.contacts'

The result of this command will be a table in the intercom.duckdb database.

Tables

Intercom source allows ingesting the following sources into separate tables:

Table	PK	Inc Key	Inc Strategy	Details
contacts	id	updated_at	merge	Retrieves information about contacts (visitors, users, and leads)
companies	id	updated_at	merge	Retrieves information about companies
conversations	id	updated_at	merge	Retrieves conversation data
articles	id	updated_at	merge	Retrieves help center articles
tags	id	-	replace	Retrieves tags used to organize contacts and companies
segments	id	-	replace	Retrieves segments for filtering contacts and companies
admins	id	-	replace	Retrieves admin user information
teams	id	-	replace	Retrieves team information
data_attributes	name	-	replace	Retrieves data attributes (both built-in and custom attributes)

Use these as --source-table parameter in the omniload ingest command.

[!TIP] Resources marked with “merge” Inc Strategy support incremental loading based on the updated_at timestamp, which means subsequent runs will only fetch new or updated records.