Intercom
Create, update, and look up Intercom contacts from inside an agent workflow.
Intercom actions let an agent manage contacts directly in a flow. An agent can create, update, retrieve, delete, and list contacts, then pass the results to later steps.
Supported actions
| Group | Actions |
|---|---|
| Contact | Create, Update, Get, Delete, List |
Prerequisites
How to use these actions
- Map text inputs from earlier steps. Inputs such as Email, Name, and Contact ID accept a value mapped from a previous step.
- Fixed value inputs. The Per Page count and the Unsubscribed From Emails toggle are set to fixed values.
- Identifying a user contact. When creating a contact with the
userrole, provide either an Email or an External ID. - List results page with a cursor. To page through more contacts, pass the cursor from the previous response into Starting After on the next call.
Actions
Contact
Intercom Contact Create
Creates a new contact.
| Input | Required | Description |
|---|---|---|
| Role | Yes | The contact role, either user or lead. Defaults to user. |
| Conditional | The contact's email address. Required for a user role contact when External ID is not set. | |
| External ID | Conditional | A unique ID from your own system. Required for a user role contact when Email is not set. |
| Name | No | The contact's name. |
| Phone | No | The contact's phone number. |
| Avatar | No | A URL to an avatar image. |
user role contact requires an Email or an External ID. A lead does not.Intercom Contact Update
Updates an existing contact.
| Input | Required | Description |
|---|---|---|
| Contact ID | Yes | The unique identifier of the contact to update. |
| No | The contact's email address. | |
| External ID | No | A unique ID from your own system. |
| Name | No | The contact's name. |
| Phone | No | The contact's phone number. |
| Avatar | No | A URL to an avatar image. |
| Unsubscribed From Emails | No | Toggle. Whether the contact is unsubscribed from emails. |
Intercom Contact Get
Retrieves a contact by ID.
| Input | Required | Description |
|---|---|---|
| Contact ID | Yes | The unique identifier of the contact to retrieve. |
Intercom Contact Delete
Deletes a contact.
| Input | Required | Description |
|---|---|---|
| Contact ID | Yes | The unique identifier of the contact to delete. |
Intercom Contact List
Lists contacts.
| Input | Required | Description |
|---|---|---|
| No | Filter results to contacts with this email address. | |
| Per Page | No | Number of contacts per page, from 1 to 150. Defaults to 50. |
| Starting After | No | Pagination cursor from a previous response. |
Example
An agent that keeps a contact record in sync after a support chat:
An Intercom Contact List action filters by the customer's Email to find an existing record.
A branch runs Intercom Contact Create with Role set to user and the customer's Email when no match was found.
An Intercom Contact Update action maps Contact ID to the matched or newly created contact and sets the Name and Phone gathered during the chat.
Troubleshooting
For issues common to every vendor, see the Actions overview.