Skip to main content

Intercom Component

Manage companies, contacts and tags on the Intercom platform

Component key: intercom

Description#

Intercom is a tool purpose-built for sales, marketing, and support to use together.

Intercom Connections#

Intercom#

InputDefaultNotes
Input
Authorize URL
string
/ Required
Hidden Field
Default
https://app.intercom.com/oauth
Notes
Authorization URL for Intercom
Input
Client ID
string
/ Required
Default
Notes
Client ID of your Intercom app
Input
Client Secret
password
/ Required
Default
Notes
Client Secret of your Intercom app
Input
Scopes
string
Hidden Field
Default
Notes
Space delimited scopes
Input
Token URL
string
/ Required
Hidden Field
Default
https://api.intercom.io/auth/eagle/token
Notes
Token URL for Intercom

Actions#

Archive Contact#

Archive an existing Contact | key: archiveContact

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom

Output Example Payload#

{  "data": {    "id": "5ba682d23d7cf92bef87bfd4",    "object": "contact",    "archived": true  }}

Attach Company to Contact#

Attach Company to Contact | key: attachCompany

InputNotes
Input
Company ID
string
/ Required
Notes
Identifier of Company
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom

Attach Tag to Contact#

Attach a Tag to a Contact | key: attachTag

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom
Input
Tag ID
string
/ Required
Notes
Identifier of Tag

Create Company#

Create a new Company | key: createCompany

InputNotes
Input
Company ID
string
/ Required
Notes
Company ID you have defined for the company
Input
Connection
connection
/ Required
Notes
 
Input
Industry
string
Notes
The industry this company operates in
Input
Monthly Spend
string
Notes
How much revenue the company generates for your business
Input
Name
string
/ Required
Notes
Name of the company
Input
Plan
string
Notes
Name of the plan associated with the company
Input
Remote Created At
string
/ Required
Notes
Time the company was created by you
Input
Size
string
Notes
Number of employees in this company
Input
Website
string
Notes
The URL for this company's website

Output Example Payload#

{  "data": {    "type": "company",    "id": "531ee472cce572a6ec000006",    "name": "Blue Sun",    "plan": "plan1",    "company_id": "6",    "remote_created_at": 1394531169,    "created_at": 1394533506,    "updated_at": 1396874658,    "size": 85,    "website": "http://www.example.com",    "industry": "Manufacturing",    "monthly_spend": 49,    "session_count": 26,    "user_count": 10,    "custom_attributes": {      "paid_subscriber": true,      "team_mates": 0    }  }}

Create Contact#

Create a new Contact | key: createContact

InputDefaultNotes
Input
Avatar URL
string
Default
Notes
An image URL containing the avatar of a contact
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Email
string
/ Required
Default
Notes
Email of the contact
Input
External ID
string
Default
Notes
Unique identifier for the entity from external systems
Input
Last Seen At
string
Default
Notes
The time when the contact was last seen
Input
Name
string
Default
Notes
Name of the contact
Input
Phone
string
Default
Notes
Phone of the contact
Input
Role
string
/ Required
Default
Notes
The role of the contact
Input
Signed Up At
string
Default
Notes
The time specified for when a contact signed up
Input
Unsubscribed From Emails
boolean
Default
false
Notes
Whether the contact is unsubscribed from emails

Output Example Payload#

{  "data": {    "type": "contact",    "id": "5ba682d23d7cf92bef87bfd4",    "workspace_id": "ecahpwf5",    "external_id": "25",    "role": "user",    "email": "wash@serenity.io",    "phone": "+1123456789",    "name": "Hoban Washburn",    "avatar": "https://example.org/128Wash.jpg",    "owner_id": 127,    "social_profiles": {      "type": "list",      "data": [        {          "type": "social_profile",          "name": "Twitter",          "url": "http://twitter.com/th1sland"        }      ]    },    "unsubscribed_from_emails": false,    "created_at": 1571672154,    "updated_at": 1571672158,    "signed_up_at": 1571069751,    "last_seen_at": 1571069751,    "last_replied_at": 1571672158,    "last_contacted_at": 1571672158,    "last_email_opened_at": 1571673478,    "last_email_clicked_at": 1571676789,    "language_override": null,    "browser": "chrome",    "browser_version": "77.0.3865.90",    "browser_language": "en",    "os": "OS X 10.14.6",    "location": {      "type": "location",      "country": "Ireland",      "region": "Dublin",      "city": "Dublin"    },    "android_app_name": null,    "android_app_version": null,    "android_device": null,    "android_os_version": null,    "android_sdk_version": null,    "android_last_seen_at": null,    "ios_app_name": null,    "ios_app_version": null,    "ios_device": null,    "ios_os_version": null,    "ios_sdk_version": null,    "ios_last_seen_at": null,    "custom_attributes": {      "paid_subscriber": true,      "monthly_spend": 155.5,      "team_mates": 1    },    "tags": {      "type": "list",      "data": [        {          "type": "tag",          "id": "2",          "url": "/tags/2"        },        {          "type": "tag",          "id": "4",          "url": "/tags/4"        },        {          "type": "tag",          "id": "5",          "url": "/tags/5"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"    },    "notes": {      "type": "list",      "data": [        {          "type": "note",          "id": "20114858",          "url": "/notes/20114858"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"    },    "companies": {      "type": "list",      "data": [        {          "type": "company",          "id": "5ba686093d7cf93552a3dc99",          "url": "/companies/5ba686093d7cf93552a3dc99"        },        {          "type": "company",          "id": "5cee64a03d7cf90c51b36f19",          "url": "/companies/5cee64a03d7cf90c51b36f19"        },        {          "type": "company",          "id": "5d7668883d7cf944dbc5c791",          "url": "/companies/5d7668883d7cf944dbc5c791"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"    }  }}

Create Tag#

Create a new Tag | key: createTag

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
/ Required
Notes
Name of the tag

Output Example Payload#

{  "data": {    "id": "17513",    "name": "independent",    "type": "tag"  }}

Delete Company#

Delete an existing Company | key: deleteCompany

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Company ID
string
/ Required
Notes
Company ID you have defined for the company

Output Example Payload#

{  "data": {    "id": "5ba682d23d7cf92bef87bfd4",    "object": "company",    "deleted": "true"  }}

Delete Contact#

Delete an existing Contact | key: deleteContact

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom

Output Example Payload#

{  "data": {    "id": "5ba682d23d7cf92bef87bfd4",    "object": "contact",    "deleted": true  }}

Delete Tag#

Delete an existing Tag | key: deleteTag

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
/ Required
Notes
ID of the tag

Output Example Payload#

{  "data": {    "id": "17513",    "name": "independent",    "type": "tag"  }}

Detach Company from Contact#

Detach Company from Contact | key: detachCompany

InputNotes
Input
Company ID
string
/ Required
Notes
Identifier of Company
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom

Detach Tag from Contact#

Detach a Tag from a Contact | key: detachTag

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom
Input
Tag ID
string
/ Required
Notes
Identifier of Tag

List Companies#

Page through all Companies | key: listCompanies

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Starting After Cursor
string
Notes
Cursor used for pagination to fetch next page of results

List Tags#

List all Tags | key: listTags

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": [    {      "id": "17513",      "name": "independent",      "type": "tag"    }  ]}

Raw Request#

Issue a raw HTTP request to the Intercom API | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Search Contacts#

Search through all Contacts | key: searchContacts

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Email
string
Notes
Email of the contact
Input
Name
string
Notes
Name of the contact
Input
Role
string
Notes
The role of the contact
Input
Starting After Cursor
string
Notes
Cursor used for pagination to fetch next page of results

Unarchive Contact#

Unarchive an archived Contact | key: unarchiveContact

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
Notes
Unique identifier for the entity given by Intercom

Output Example Payload#

{  "data": {    "id": "5ba682d23d7cf92bef87bfd4",    "object": "contact",    "archived": false  }}

Update Company#

Update an existing Company | key: updateCompany

InputNotes
Input
Company ID
string
/ Required
Notes
Company ID you have defined for the company
Input
Connection
connection
/ Required
Notes
 
Input
Industry
string
Notes
The industry this company operates in
Input
Monthly Spend
string
Notes
How much revenue the company generates for your business
Input
Name
string
Notes
Name of the company
Input
Plan
string
Notes
Name of the plan associated with the company
Input
Remote Created At
string
Notes
Time the company was created by you
Input
Size
string
Notes
Number of employees in this company
Input
Website
string
Notes
The URL for this company's website

Output Example Payload#

{  "data": {    "type": "company",    "id": "531ee472cce572a6ec000006",    "name": "Blue Sun",    "plan": "plan1",    "company_id": "6",    "remote_created_at": 1394531169,    "created_at": 1394533506,    "updated_at": 1396874658,    "size": 85,    "website": "http://www.example.com",    "industry": "Manufacturing",    "monthly_spend": 49,    "session_count": 26,    "user_count": 10,    "custom_attributes": {      "paid_subscriber": true,      "team_mates": 0    }  }}

Update Contact#

Update an existing Contact | key: updateContact

InputDefaultNotes
Input
Avatar URL
string
Default
Notes
An image URL containing the avatar of a contact
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Email
string
/ Required
Default
Notes
Email of the contact
Input
External ID
string
Default
Notes
Unique identifier for the entity from external systems
Input
ID
string
Default
Notes
Unique identifier for the entity given by Intercom
Input
Last Seen At
string
Default
Notes
The time when the contact was last seen
Input
Name
string
Default
Notes
Name of the contact
Input
Phone
string
Default
Notes
Phone of the contact
Input
Role
string
/ Required
Default
Notes
The role of the contact
Input
Signed Up At
string
Default
Notes
The time specified for when a contact signed up
Input
Unsubscribed From Emails
boolean
Default
false
Notes
Whether the contact is unsubscribed from emails

Output Example Payload#

{  "data": {    "type": "contact",    "id": "5ba682d23d7cf92bef87bfd4",    "workspace_id": "ecahpwf5",    "external_id": "25",    "role": "user",    "email": "wash@serenity.io",    "phone": "+1123456789",    "name": "Hoban Washburn",    "avatar": "https://example.org/128Wash.jpg",    "owner_id": 127,    "social_profiles": {      "type": "list",      "data": [        {          "type": "social_profile",          "name": "Twitter",          "url": "http://twitter.com/th1sland"        }      ]    },    "unsubscribed_from_emails": false,    "created_at": 1571672154,    "updated_at": 1571672158,    "signed_up_at": 1571069751,    "last_seen_at": 1571069751,    "last_replied_at": 1571672158,    "last_contacted_at": 1571672158,    "last_email_opened_at": 1571673478,    "last_email_clicked_at": 1571676789,    "language_override": null,    "browser": "chrome",    "browser_version": "77.0.3865.90",    "browser_language": "en",    "os": "OS X 10.14.6",    "location": {      "type": "location",      "country": "Ireland",      "region": "Dublin",      "city": "Dublin"    },    "android_app_name": null,    "android_app_version": null,    "android_device": null,    "android_os_version": null,    "android_sdk_version": null,    "android_last_seen_at": null,    "ios_app_name": null,    "ios_app_version": null,    "ios_device": null,    "ios_os_version": null,    "ios_sdk_version": null,    "ios_last_seen_at": null,    "custom_attributes": {      "paid_subscriber": true,      "monthly_spend": 155.5,      "team_mates": 1    },    "tags": {      "type": "list",      "data": [        {          "type": "tag",          "id": "2",          "url": "/tags/2"        },        {          "type": "tag",          "id": "4",          "url": "/tags/4"        },        {          "type": "tag",          "id": "5",          "url": "/tags/5"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"    },    "notes": {      "type": "list",      "data": [        {          "type": "note",          "id": "20114858",          "url": "/notes/20114858"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"    },    "companies": {      "type": "list",      "data": [        {          "type": "company",          "id": "5ba686093d7cf93552a3dc99",          "url": "/companies/5ba686093d7cf93552a3dc99"        },        {          "type": "company",          "id": "5cee64a03d7cf90c51b36f19",          "url": "/companies/5cee64a03d7cf90c51b36f19"        },        {          "type": "company",          "id": "5d7668883d7cf944dbc5c791",          "url": "/companies/5d7668883d7cf944dbc5c791"        }      ],      "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"    }  }}

Update Tag#

Update an existing Tag | key: updateTag

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
ID
string
/ Required
Notes
ID of the tag
Input
Name
string
/ Required
Notes
Name of the tag

Output Example Payload#

{  "data": {    "id": "17513",    "name": "independent",    "type": "tag"  }}