Intercom Cloud Mode (Actions) Destination
Additional versions of this destination are available
This page is about the Intercom Cloud Mode (Actions) Destination. See below for information about other versions of the Intercom destination:
Intercom is a customer communications platform that shows you who is using your product. Intercom allows you to personally communicate with your users with targeted content, behavior-driven messages, and conversational support.
When you use the Intercom Cloud Mode (Actions) destination, Segment will send your data to Intercom's REST API.
Intercom Cloud Mode (Actions) provides the following benefits over the classic Intercom destination:
- Fewer settings. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings.
- Clearer mapping of data. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to the destination.
- Granular control over data sent. You can customize the conditions under which the events are sent to Intercom.
- Support for lead creation. You can create contacts with a role of
lead, associate them with a company, send events for them, and convert them to auser.
The Intercom Cloud Mode (Actions) destination doesn't have access to Intercom's chat widget. Implement the Intercom Web Actions destination if you need access to Intercom's chat widget.
- From the Segment web app, navigate to Connections > Catalog.
- Search for Intercom Cloud Mode (Actions) in the Destinations Catalog, and select the destination.
- Click Configure Intercom Cloud Mode (Actions).
- Select the source that will send data to Intercom Cloud Mode (Actions) and follow the steps to name your destination.
- On the Settings tab, authenticate with Intercom using OAuth. If you have multiple Intercom workspaces, choose one workspace that you'll connect to Segment.
- Follow the steps in the Destinations Actions documentation on Customizing mappings.
- Enable the destination and configured mappings.
Build your own Mappings. Combine supported triggers with the following Intercom Cloud Mode-supported actions:
Mapping limits per destination
Create or update a company in Intercom and attach a contact.
Identify Company is a Cloud action. The default Trigger is type = "group"
Optional
The time the company was created by you.
Optional
A unique identifier for the contact generated outside Intercom. External ID is required to attach a contact to a company if no email or Contact ID is provided.
Optional
The contact's email address. Email is required to attach a contact to a company if no External ID or Contact ID is provided.
The unique identifier of the company. Once set, this can't be updated.
Optional
The unique identifier for the contact which is given by Intercom. If no Contact ID is provided, Segment will use External ID or email to find a contact to attach to the company.
Optional
The name of the company.
Optional
The monthly spend of the company, e.g. how much revenue the company generates for your business.
Optional
The name of the plan you have associated with the company.
Optional
The number of employees in the company.
Optional
The URL for the company's website
Optional
The industry that the company operates in.
Optional
A hash of key-value pairs containing any other data about the company you want Intercom to store. You can only write to custom attributes that already exist in your Intercom workspace. Please ensure custom attributes are created in Intercom first. See Intercom documentation for more information on creating attributes.
Submit an event to Intercom.
Track Event is a Cloud action. The default Trigger is type = "track"
The name of the event that occurred. Names are treated as case insensitive. Periods and dollar signs in event names are replaced with hyphens.
The time the event occurred as a UTC Unix timestamp. Segment will convert to Unix if not already converted.
Optional
Your identifier for the user who performed the event. User ID is required if no email or Contact ID is provided.
Optional
The email address for the user who performed the event. Email is required if no User ID or Contact ID is provided.
Optional
The amount associated with a purchase. Segment will multiply by 100 as Intercom requires the amount in cents.
Optional
The currency of the purchase amount. Segment will default to USD if revenue is provided without a currency.
Optional
Intercom's unique identifier for the contact. If no Contact ID is provided, Segment will use User ID or Email to find a user or lead.
Optional
Optional metadata describing the event. Each event can contain up to ten metadata key-value pairs. If you send more than ten keys, Intercom will ignore the rest. Intercom does not support nested JSON structures within metadata.
Create or update a contact in Intercom
Identify Contact is a Cloud action. The default Trigger is type = "identify"
The role of the contact. Accepted values are user or lead.
Optional
A unique identifier for the contact generated outside of Intercom. External ID is required if the role is user and email is blank. External IDs cannot be set if the role is lead.
Optional
The contact's email address. Email is required if the role is user and External ID is blank.
Optional
The contact's phone number.
Optional
The contact's name.
Optional
An image URL containing the avatar of a contact.
Optional
The time specified for when a contact signed up.
Optional
The time when the contact was last seen.
Optional
The ID of an admin that has been assigned account ownership of the contact.
Optional
The contact's email unsubscribe status.
Optional
The custom attributes which are set for the contact. You can only write to custom attributes that already exist in your Intercom workspace. Please ensure custom attributes are created in Intercom first. See Intercom documentation for more information on creating attributes.
If a company is created without an attached user, the company does not appear on Intercom's dashboard. This is expected. Once a user is attached to the company, it should appear in the list of companies. You can associate a company with a user by providing your Identify Contact mapping with a user's External ID, Email Address, or Contact ID.
When you use the Identify Company action, Segment creates or updates a company's information. In the same action, Segment also attaches the user in your group call to that company. If the user doesn't exist in Intercom when the action runs, Segment creates or updates the company but can't attach the user. Ensure the user is created in Intercom first.
A 404 Not Found error typically occurs when attempting to update a user in Intercom who does not yet exist in the system. This can happen if an Identify event, which includes the corresponding userId, was not sent before the Track event that resulted in the 404 error.
To resolve this, ensure that Identify events are sent before Track events to ensure proper processing and avoid errors.