Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Intercom Destination


Destination Info
  • Accepts Page, Group, Identify and Track calls.
  • Refer to it as Intercom in the Integrations object
(warning)

This destination is for mobile connections only

This destination should only be used for mobile connections. New versions of the destination are available for browser and server connections. See Intercom Cloud Mode (Actions) and Intercom Web (Actions) for more information.


Getting started

getting-started page anchor
  1. From the Segment Destinations page, click Add Destination.
  2. Search for "Intercom" and select it.
  3. Choose a Kotlin or Swift mobile source to connect to Intercom.
  4. Authorize your Intercom account in Segment and select the Intercom Account to sync with Segment.
  5. Find your "App ID" in the Intercom UI(link takes you to an external page) or by navigating to the Gear Menu and clicking on App Settings > API Keys. It should look something like 9iefb489.

Kotlin

kotlin page anchor

To find implementation details for Segment's Kotlin Intercom Destination Plugin, review the Intercom plugin documentation.

To find implementation details for Segment's Swift Intercom Destination Plugin, review the Intercom plugin documentation.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Custom Inbox Button Selectorstring

Optional

By default, Intercom will inject their own inbox button onto the page, but you can choose to use your own custom button instead by providing a CSS selector like: #my-button. Note: you must have enabled the Show the Intercom Inbox setting for this to work. The default value is #IntercomDefaultWidget

Default: #IntercomDefaultWidget

API Baseselect

Optional

For customers who are using Regional Data Hosting for Intercom, you can choose the regional API to ensure your Messenger is pointing to your Regional workspace.


Enter your API Keystring

Optional

Note: this is deprecated . Intercom requires events hitting their server-side api authenticated via OAuth.


App ID (required for analytics.js and mobile)string

Optional

Note: this is required to send data to Intercom from your browser or mobile app. You can find your App ID after activating your account under the Gear Menu > App Settings > API Keys at Intercom.io(link takes you to an external page). It should look something like this: 9iefb489.


Include Context with Identify Callsboolean

Optional

Pass context data with Identify calls as Custom Attributes. Includes device.type, device.manufacturer, device.model, os.name, os.version, app.name, app.version

Default: false

Enter your Mobile API Keystring

Optional

Note: this is required to send data to Intercom from your mobile apps.


Rich Link Propertiesarray

Optional

To use Intercom's Rich Link object, list the name of the exact Segment property name and make sure the value of those properties only include url and value keys.