Intercom

Intercom is a customer communication platform.

It replicates data using the Intercom API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To generate your client ID and secret:

Log into your Intercom Developers account.
Select Developer Hub at the top of the page.
Create a new OAuth application.
Navigate to Authentication from the left navigation bar and click Edit.
Make sure OAuth is activated.
Make sure Authorized Redirect URIs is set to https://connector.qlik.com/auth/oauth/v3.htm.
Copy the client ID and client secret that are generated, to use in the connection settings.

Creating the connection

For more information, see Connecting to SaaS applications.

Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify.
Tip noteYou may need to scroll down to see this field.
When status is Verified, the authentication is verified.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
Client ID	Client ID of your Intercom account.
Client Secret	Client secret of your Intercom account.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

admins

The admins table lists info about the admins in your Intercom account. An admin is a user, or teammate, in your Intercom account.

Replication Method

Full Table

Primary Key

Useful links

Intercom documentation

Intercom API method

admin_ids

ARRAY

avatar

OBJECT

This is a nested data structure:

image_url: STRING

away_mode_enabled

BOOLEAN

away_mode_reassign

BOOLEAN

email

STRING

has_inbox_seat

BOOLEAN

STRING

job_title

STRING

name

STRING

team_ids

ARRAY

type

STRING

companies

The companies table contains info about companies that use your Intercom product.

Custom attributes

If applicable, Stitch will replicate custom fields related to companies in Intercom.

Limitations

Intercom’s API limits the number of simultaneous requests a single Intercom app, or connection, can make to the endpoint. Stitch uses this endpoint to replicate company data. Currently, only one request can occur at a time.

If multiple connections exist and they attempt to use this endpoint at the same time, only the connection who made the request first will succeed.

This means that if Stitch attempts to extract data when another connection is using the endpoint, Extraction will fail and an error will surface in the Extraction Logs.

To prevent or minimize this issue, we recommend limiting the number of connections a single workspace has or scheduling extraction jobs in Stitch around your other connections’ usage.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

company_id

STRING

created_at

DATE-TIME

custom_attributes

OBJECT

STRING

industry

STRING

last_request_at

DATE-TIME

monthly_spend

NUMBER

name

STRING

plan

OBJECT

This is a nested data structure:

id: STRING
name: STRING
type: STRING

remote_created_at

DATE-TIME

segments

ARRAY

This is a nested data structure:

id: STRING

session_count

INTEGER

size

INTEGER

tags

ARRAY

This is a nested data structure:

id: STRING

type

STRING

updated_at

DATE-TIME

user_count

INTEGER

website

STRING

company_attributes

The company_attributes lists data attributes for a specified company in your Intercom account.

Replication Method

Full Table

Primary Key

_sdc_record_hash

Useful links

Intercom documentation

Intercom API method

_sdc_record_hash

STRING

admin_id

STRING

api_writable

BOOLEAN

archived

BOOLEAN

created_at

DATE-TIME

custom

BOOLEAN

data_type

STRING

description

STRING

full_name

STRING

INTEGER

label

STRING

model

STRING

name

STRING

options

ARRAY

type

STRING

ui_writable

BOOLEAN

updated_at

DATE-TIME

company_segments

The company_segments table contains information about company segments in your Intercom account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

count

INTEGER

created_at

DATE-TIME

STRING

name

STRING

person_type

STRING

type

STRING

updated_at

DATE-TIME

contact_attributes

The contact_attributes table contains information about contact attributes in your Intercom account.

Replication Method

Full Table

Primary Key

_sdc_record_hash

Useful links

Intercom documentation

Intercom API method

_sdc_record_hash

STRING

admin_id

STRING

api_writable

BOOLEAN

archived

BOOLEAN

created_at

DATE-TIME

custom

BOOLEAN

data_type

STRING

description

STRING

full_name

STRING

INTEGER

label

STRING

model

STRING

name

STRING

options

ARRAY

type

STRING

ui_writable

BOOLEAN

updated_at

DATE-TIME

contacts

The contacts table contains info about users and leads in your Intercom account.

Custom attributes

If applicable, Stitch will replicate custom fields related to contacts in Intercom.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

android_app_name

STRING

android_app_version

STRING

android_device

STRING

android_last_seen_at

DATE-TIME

android_os_version

STRING

android_sdk_version

STRING

avatar

STRING

browser

STRING

browser_language

STRING

browser_version

STRING

companies

ARRAY

This is a nested data structure:

id: STRING
type: STRING
url: STRING

created_at

DATE-TIME

custom_attributes

OBJECT

email

STRING

external_id

STRING

has_hard_bounced

BOOLEAN

STRING

ios_app_name

STRING

ios_app_version

STRING

ios_device

STRING

ios_last_seen_at

DATE-TIME

ios_os_version

STRING

ios_sdk_version

STRING

language_override

STRING

last_contacted_at

DATE-TIME

last_email_clicked_at

DATE-TIME

last_email_opened_at

DATE-TIME

last_replied_at

DATE-TIME

last_seen_at

DATE-TIME

location

OBJECT

This is a nested data structure:

city: STRING
continent_code: STRING
country: STRING
country_code: STRING
region: STRING
type: STRING

marked_email_as_spam

BOOLEAN

name

STRING

notes

OBJECT

This is a nested data structure:

data: ARRAY, which is also a nested data structure.
- id: STRING
- type: STRING
- url: STRING
has_more: BOOLEAN
total_count: INTEGER
type: STRING
url: STRING

STRING

owner_id

INTEGER

phone

STRING

role

STRING

signed_up_at

DATE-TIME

social_profiles

OBJECT

This is a nested data structure:

data: ARRAY, which is also a nested data structure.
- name: STRING
- type: STRING
- url: STRING
type: STRING

tags

ARRAY

This is a nested data structure:

id: STRING

type

STRING

unsubscribed_from_emails

BOOLEAN

updated_at

DATE-TIME

workspace_id

STRING

conversation_parts

The conversation_parts table lists the individual parts of conversations in your Intercom account.

Note: When this table is replicated, all conversation parts associated with an updated conversation will be replicated.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

assigned_to

STRING

attachments

ARRAY

This is a nested data structure:

content_type: STRING
filesize: INTEGER
height: INTEGER
name: STRING
type: STRING
url: STRING
width: INTEGER

author

OBJECT

This is a nested data structure:

email: STRING
id: STRING
name: STRING
type: STRING

body

STRING

conversation_created_at

DATE-TIME

conversation_id

STRING

conversation_total_parts

INTEGER

conversation_updated_at

DATE-TIME

created_at

DATE-TIME

external_id

STRING

notified_at

DATE-TIME

part_type

STRING

redacted

BOOLEAN

type

STRING

updated_at

DATE-TIME

conversations

The conversations table contains info about user conversations in your Intercom account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

admin_assignee_id

INTEGER

contacts

ARRAY

This is a nested data structure:

id: STRING
type: STRING

conversation_message

OBJECT

This is a nested data structure:

attachments: ARRAY, which is also a nested data structure.
- content_type: STRING
- filesize: INTEGER
- height: INTEGER
- name: STRING
- type: STRING
- url: STRING
- width: INTEGER
author: OBJECT, which is also a nested data structure.
- email: STRING
- id: STRING
- name: STRING
- type: STRING
body: STRING
delivered_as: STRING
id: STRING
subject: STRING
type: STRING
url: STRING

conversation_rating

OBJECT

This is a nested data structure:

contact: OBJECT, which is also a nested data structure.
- id: STRING
- type: STRING
created_at: DATE-TIME
customer: OBJECT, which is also a nested data structure.
- id: STRING
- type: STRING
rating: INTEGER
remark: STRING
teammate: OBJECT, which is also a nested data structure.
- id: STRING
- type: STRING

created_at

DATE-TIME

custom_attributes

OBJECT

customer_first_reply

OBJECT

created_at

DATE-TIME

type

STRING

url

STRING

customers

ARRAY

STRING

type

STRING

first_contact_reply

OBJECT

This is a nested data structure:

created_at: DATE-TIME
type: STRING
url: STRING

STRING

open

BOOLEAN

priority

STRING

read

BOOLEAN

sent_at

DATE-TIME

sla_applied

OBJECT

This is a nested data structure:

sla_name: STRING
sla_status: STRING

snoozed_until

DATE-TIME

source

OBJECT

This is a nested data structure:

attachments: ARRAY
author: OBJECT, which is also a nested data structure.
- email: STRING
- id: STRING
- name: STRING
- type: STRING
body: STRING
delivered_as: STRING
id: STRING
redacted: BOOLEAN
subject: STRING
type: STRING
url: STRING

state

STRING

statistics

OBJECT

This is a nested data structure:

count_assignments: INTEGER
count_conversation_parts: INTEGER
count_reopens: INTEGER
first_admin_reply_at: DATE-TIME
first_assignment_at: DATE-TIME
first_close_at: DATE-TIME
first_contact_reply_at: DATE-TIME
last_admin_reply_at: DATE-TIME
last_assignment_admin_reply_at: DATE-TIME
last_assignment_at: DATE-TIME
last_close_at: DATE-TIME
last_closed_by: DATE-TIME, which is also a nested data structure.
- email: STRING
- id: STRING
- name: STRING
- type: STRING
last_closed_by_id: INTEGER
last_contact_reply_at: DATE-TIME
median_time_to_reply: INTEGER
time_to_admin_reply: INTEGER
time_to_assignment: INTEGER
time_to_first_close: INTEGER
time_to_last_close: INTEGER
type: STRING

tags

ARRAY

This is a nested data structure:

applied_at: DATE-TIME
applied_by: OBJECT, which is also a nested data structure.
- id: STRING
- type: STRING
id: STRING
name: STRING
type: STRING

team_assignee_id

INTEGER

teammates

OBJECT

This is a nested data structure:

admins: ARRAY, which is also a nested data structure.
- id: STRING
- type: STRING
type: STRING

title

STRING

type

STRING

updated_at

DATE-TIME

user

OBJECT

This is a nested data structure:

id: STRING
type: STRING

waiting_since

DATE-TIME

segments

The segments table contains information about segments within your Intercom account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Intercom documentation Intercom API method

count

INTEGER

created_at

DATE-TIME

STRING

name

STRING

person_type

STRING

type

STRING

updated_at

DATE-TIME

teams

The teams table contains information about teams in your Intercom account.

Replication Method

Full Table

Primary Key

Useful links

Intercom documentation

Intercom API method

admin_ids

ARRAY

STRING

name

STRING

type

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here