Intercom Connector Setup Guide

[#1]

This article describes how to set up the Intercom connector in your Customer Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name	AudienceStream	EventStream
Create or Update User	✓	✓
Add Tag Based on ID	✓	✗
Add Tag Based on User ID	✓	✗
Add Tag Based on Email	✓	✗

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

• Access Token: Access Tokens use the bearer authorization header when you make a request. For more information about creating an access token, see Authorization: Access Tokens.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Create or Update User

Parameters

Parameter	Description
User ID	A unique string identifier for the user. It is required on creation if an email is not supplied *Either User ID or Email must be supplied Reference the following API documentation for more info
Email	The user's email address. It is required on creation if a user_id is not supplied *Either User ID or Email must be supplied
Phone Number	The user's phone number
ID	The ID may be used for user updates
Signed Up At	The time the user signed up
Name	The user's full name
Last Seen IP	An IP address (e.g. "1.2.3.4") representing the last IP address the user visited from your application form. (Used for updating location data)
Last Seen User Agent	The user agent the user last visited your application with
Last Request At	A UNIX timestamp (in seconds) representing the date the user last visited your application
Unsubscribed From Emails	A Boolean value representing the users unsubscribed status Default value if not sent is false
Update Last Request At	A Boolean value, which if true, instructs Intercom to update the users' last_request_at value to the current API service time in UTC Default value if not sent is false
New Session	A Boolean value, which if true, instructs Intercom to register the request as a session

Action - Add Tag Based on ID

Parameters

Parameter	Description
Name	Name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference
ID	ID of the user.
Untag	To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged.

Action - Add Tag Based on User ID

Parameters

Parameter	Description
Name	Name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference
User ID	The User ID of the user
Untag	To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged.

Action - Add Tag Based on Email

Parameters

Parameter	Description
Name	The name of the tag. For more information on this endpoint, visit: Tag or Untag Users Reference
Email	Email of the user
Untag	To untag a company or user, each user or company object sent in the tagging request can be submitted with an untag field whose value is set to true. Setting the untagvalue to false is the same as requesting the object be tagged.