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.
Connections
Intercom
To connect to Intercom you will need to create a new app in their Developer Hub.
Click "New App" and select "Public app" (you can use "Internal integration" if you do not need to connect to customer Intercom workspaces).
To enable OAuth you need to navigate to "Authentication", click the "Edit" button, and check "Use OAuth". Click "Add redirect URL" and enter the callback URL: https://oauth2.prismatic.io/callback
You can also use this opportunity to reduce the selected Permissions (scopes) if desired. Once complete, click "Save".
Next, collect the Client ID and Client secret from the "Basic information" page.
You are now ready to create the OAuth 2.0 connection to Intercom:
- Enter the Client ID and Client secret values into the same named fields.
Save your integration and you should now be able to authenticate to Intercom.
Note that you will need to submit your Intercom app for review when it is ready for production.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | Authorization URL for Intercom | https://app.intercom.com/oauth |
| Client ID | Client ID of your Intercom app | |
| Client Secret | Client Secret of your Intercom app | |
| Scopes | Space delimited scopes | |
| Token URL | Token URL for Intercom | https://api.intercom.io/auth/eagle/token |
Intercom Access Token
You should use the given access Access Token if:
- You want to use the API to interact with your own Intercom app
- You have scripts to push or extract data from your Intercom app
- You want to use the API to programmatically automate certain actions in your own Intercom app
- The data you interact with programmatically is your own customer data
How to get your Access Token
Intercom provide you with an Access Token as soon as you create an app on your workspace. You can find your Access Token in the Configure > Authentication section in your app within the Developer Hub.
You will also see it in your Test & Publish > Your Workspaces page of your app in the Developer Hub. This lists out all of your workspaces that have the app installed. More about how this works can be found in their Installing & Uninstalling Apps guide.
Never give your Access Token to a third party
Your Access Token can give access to your private Intercom data and should be treated like a password. If an app provider asks you for your Access Token, please do not provide it. Instead, let us know - apps are required to use OAuth rather than asking users for Access Tokens.
| Input | Notes | Example |
|---|---|---|
| Access Token | Access Token for Intercom |
Data Sources
Select Company
A Picklist of Intercom companies | key: selectCompany | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Contact
A Picklist of Intercom contacts | key: selectContact | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Tag
A Picklist of Intercom tags | key: selectTag | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Ticket
A Picklist of Intercom open tickets | key: selectTicket | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Select Ticket Type
A Picklist of Intercom ticket types | key: selectTicketType | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
Actions
Archive Contact
Archive an existing Contact | key: archiveContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"id": "5ba682d23d7cf92bef87bfd4",
"object": "contact",
"archived": true
}
}
Attach Company to Contact
Attach Company to Contact | key: attachCompany
| Input | Notes | Example |
|---|---|---|
| Company ID | Identifier of Company | |
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"type": "company",
"company_id": "1",
"id": "667d608d8a68186f43bafd70",
"app_id": "this_is_an_id166_that_should_be_at_least_",
"name": "company6",
"remote_created_at": 1719492749,
"created_at": 1719492749,
"updated_at": 1719492749,
"monthly_spend": 0,
"session_count": 0,
"user_count": 1,
"tags": {
"type": "tag.list",
"tags": []
},
"segments": {
"type": "segment.list",
"segments": []
},
"plan": {},
"custom_attributes": {}
}
}
Attach Tag to Contact
Attach a Tag to a Contact | key: attachTag
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom | |
| Tag ID | Identifier of Tag |
Create Company
Create a new Company | key: createCompany
| Input | Notes | Example |
|---|---|---|
| Company ID | Identifier of Company | |
| Connection | ||
| Industry | The industry this company operates in | |
| Monthly Spend | How much revenue the company generates for your business | |
| Name | Name of the company | |
| Plan | Name of the plan associated with the company | |
| Remote Created At | Time the company was created by you | |
| Size | Number of employees in this company | |
| Website | The URL for this company's website |
{
"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
| Input | Notes | Example |
|---|---|---|
| Avatar URL | An image URL containing the avatar of a contact | |
| Connection | ||
Email of the contact | ||
| External ID | Unique identifier for the entity from external systems | |
| Last Seen At | The time when the contact was last seen | |
| Name | Name of the contact | |
| Phone | Phone of the contact | |
| Role | The role of the contact | |
| Signed Up At | The time specified for when a contact signed up | |
| Unsubscribed From Emails | Whether the contact is unsubscribed from emails | false |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Name | Name of the tag |
{
"data": {
"id": "17513",
"name": "independent",
"type": "tag"
}
}
Create Ticket
Create a new Ticket | key: createTicket
| Input | Notes | Example |
|---|---|---|
| Company ID | The ID of the company that the ticket is associated with. The ID that you set upon company creation. | 147 |
| Connection | ||
| Contact ID | The ID / email / external Id of the user affected by this ticket. | 6657af026abd0167d9419def |
| Ticket Attributes | The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are default_title and default_description | |
| Ticket Type ID | The ID of the type of ticket you want to create | 147 |
{
"data": {
"type": "ticket",
"id": "773",
"ticket_id": "35",
"ticket_attributes": {
"_default_title_": "example",
"_default_description_": "there is a problem"
},
"ticket_state": "submitted",
"ticket_state_internal_label": "Submitted",
"ticket_state_external_label": "Submitted",
"ticket_type": {
"type": "ticket_type",
"id": "147",
"name": "my-ticket-type-15",
"description": "my ticket type description is awesome.",
"icon": "🦁",
"workspace_id": "this_is_an_id648_that_should_be_at_least_",
"archived": false,
"created_at": 1717022465,
"updated_at": 1717022465,
"is_internal": false,
"ticket_type_attributes": {
"type": "list",
"data": [
{
"type": "ticket_type_attribute",
"id": "388",
"workspace_id": "this_is_an_id648_that_should_be_at_least_",
"name": "_default_title_",
"description": "ola",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": true,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 147,
"archived": false,
"created_at": 1717022465,
"updated_at": 1717022465
},
{
"type": "ticket_type_attribute",
"id": "389",
"workspace_id": "this_is_an_id648_that_should_be_at_least_",
"name": "_default_description_",
"description": "ola",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": true,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 147,
"archived": false,
"created_at": 1717022465,
"updated_at": 1717022465
}
]
},
"category": "Back-office"
},
"contacts": {
"type": "contact.list",
"contacts": [
{
"type": "contact",
"id": "6657af026abd0167d9419def",
"external_id": "70"
}
]
},
"admin_assignee_id": "0",
"team_assignee_id": "0",
"created_at": 1717022466,
"updated_at": 1717022466,
"ticket_parts": {
"type": "ticket_part.list",
"ticket_parts": [
{
"type": "ticket_part",
"id": "199",
"part_type": "ticket_state_updated_by_admin",
"ticket_state": "submitted",
"previous_ticket_state": "submitted",
"created_at": 1717022466,
"updated_at": 1717022466,
"author": {
"id": "991268827",
"type": "bot",
"name": "Operator",
"email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io"
},
"attachments": [],
"redacted": false
}
],
"total_count": 1
},
"open": true,
"linked_objects": {
"type": "list",
"data": [],
"total_count": 0,
"has_more": false
},
"category": "Back-office",
"is_shared": false
}
}
Delete Company
Delete an existing Company | key: deleteCompany
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Company ID | Identifier of Company |
{
"data": {
"id": "5ba682d23d7cf92bef87bfd4",
"object": "company",
"deleted": "true"
}
}
Delete Contact
Delete an existing Contact | key: deleteContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"data": {
"id": "5ba682d23d7cf92bef87bfd4",
"object": "contact",
"deleted": true
}
}
}
Delete Tag
Delete an existing Tag | key: deleteTag
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tag ID | ID of the tag |
{
"data": {
"id": "17513",
"name": "independent",
"type": "tag"
}
}
Detach Company from Contact
Detach Company from Contact | key: detachCompany
| Input | Notes | Example |
|---|---|---|
| Company ID | Identifier of Company | |
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"type": "company",
"company_id": "1",
"id": "667d60918a68186f43bafd80",
"app_id": "this_is_an_id174_that_should_be_at_least_",
"name": "company8",
"remote_created_at": 1719492753,
"created_at": 1719492753,
"updated_at": 1719492753,
"monthly_spend": 0,
"session_count": 0,
"user_count": 0,
"tags": {
"type": "tag.list",
"tags": []
},
"segments": {
"type": "segment.list",
"segments": []
},
"plan": {},
"custom_attributes": {}
}
}
Detach Tag from Contact
Detach a Tag from a Contact | key: detachTag
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom | |
| Tag ID | Identifier of Tag |
Get Company
Retrieves an existing Company | key: getCompany
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Company ID | Identifier of Company |
{
"data": {
"type": "company",
"company_id": "1",
"id": "667d60808a68186f43bafd31",
"app_id": "this_is_an_id128_that_should_be_at_least_",
"name": "company1",
"remote_created_at": 1719492736,
"created_at": 1719492736,
"updated_at": 1719492736,
"monthly_spend": 0,
"session_count": 0,
"user_count": 1,
"tags": {
"type": "tag.list",
"tags": []
},
"segments": {
"type": "segment.list",
"segments": []
},
"plan": {},
"custom_attributes": {}
}
}
Get Contact
Retrieves an existing Contact | key: getContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"type": "contact",
"id": "667d60a98a68186f43bafdb9",
"workspace_id": "this_is_an_id252_that_should_be_at_least_",
"external_id": "70",
"role": "user",
"email": "joe@bloggs.com",
"phone": null,
"name": "Joe Bloggs",
"avatar": null,
"owner_id": null,
"social_profiles": {
"type": "list",
"data": []
},
"has_hard_bounced": false,
"marked_email_as_spam": false,
"unsubscribed_from_emails": false,
"created_at": 1719492777,
"updated_at": 1719492777,
"signed_up_at": 1719492777,
"last_seen_at": null,
"last_replied_at": null,
"last_contacted_at": null,
"last_email_opened_at": null,
"last_email_clicked_at": null,
"language_override": null,
"browser": null,
"browser_version": null,
"browser_language": null,
"os": null,
"location": {
"type": "location",
"country": null,
"region": null,
"city": null,
"country_code": null,
"continent_code": null
},
"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": {},
"tags": {
"type": "list",
"data": [],
"url": "/contacts/667d60a98a68186f43bafdb9/tags",
"total_count": 0,
"has_more": false
},
"notes": {
"type": "list",
"data": [],
"url": "/contacts/667d60a98a68186f43bafdb9/notes",
"total_count": 0,
"has_more": false
},
"companies": {
"type": "list",
"data": [],
"url": "/contacts/667d60a98a68186f43bafdb9/companies",
"total_count": 0,
"has_more": false
},
"opted_out_subscription_types": {
"type": "list",
"data": [],
"url": "/contacts/667d60a98a68186f43bafdb9/subscriptions",
"total_count": 0,
"has_more": false
},
"opted_in_subscription_types": {
"type": "list",
"data": [],
"url": "/contacts/667d60a98a68186f43bafdb9/subscriptions",
"total_count": 0,
"has_more": false
},
"utm_campaign": null,
"utm_content": null,
"utm_medium": null,
"utm_source": null,
"utm_term": null,
"referrer": null
}
}
List Companies
Page through all Companies | key: listCompanies
| Input | Notes | Example |
|---|---|---|
| Company ID | Id of the company to be used as filter. | 147 |
| Name | Name of the company to be used as filter. | |
| Connection | ||
| Fetch All | If true, all pages of results will be fetched. | false |
| Order | The order to sort the results in. Default is 'desc'. | desc |
| Page | The page of results to fetch. | 1 |
| Per Page | How many results to return per page. Default is 15. Max is 50. | 15 |
| Segment ID | Id of the segment to be used as filter. | |
| Starting After Cursor | If you want to get the next page of data in the batch, you must make a new request with the starting_after parameter equal to the cursor pointer string. Use the starting_after parameter of the previous response. | |
| Tag ID | Id of the tag to be used as filter. |
{
"data": {
"data": [
{
"type": "company",
"company_id": "remote_companies_scroll_2",
"id": "6657add06abd0167d9419cc3",
"app_id": "this_is_an_id158_that_should_be_at_least_",
"name": "IntercomQATest1",
"remote_created_at": 1717022160,
"created_at": 1717022160,
"updated_at": 1717022160,
"monthly_spend": 0,
"session_count": 0,
"user_count": 4,
"tags": {
"type": "tag.list",
"tags": []
},
"segments": {
"type": "segment.list",
"segments": []
},
"plan": {},
"custom_attributes": {}
}
],
"pages": {
"type": "companies",
"next": null,
"page": 1,
"per_page": 15,
"total_pages": 1
}
}
}
List Contacts
Page through all Contacts | key: listContacts
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Fetch All | If true, all pages of results will be fetched. | false |
| Order | The order to sort the results in. Default is 'desc'. | desc |
| Page | The page of results to fetch. | 1 |
| Per Page | How many results to return per page. Default is 15. Max is 50. | 15 |
| Starting After Cursor | If you want to get the next page of data in the batch, you must make a new request with the starting_after parameter equal to the cursor pointer string. Use the starting_after parameter of the previous response. |
{
"data": {
"data": [
{
"type": "contact",
"id": "5ba682d23d7cf92bef87bfd4",
"external_id": "f3b87a2e09d514c6c2e79b9a",
"workspace_id": "ecahpwf5",
"role": "user",
"email": "joe@example.com",
"email_domain": "example.com",
"phone": "+1123456789",
"formatted_phone": "+1123456789",
"name": "John Doe",
"owner_id": 123,
"has_hard_bounced": true,
"marked_email_as_spam": true,
"unsubscribed_from_emails": true,
"created_at": 1571672154,
"updated_at": 1571672154,
"signed_up_at": 1571672154,
"last_seen_at": 1571672154,
"last_replied_at": 1571672154,
"last_contacted_at": 1571672154,
"last_email_opened_at": 1571672154,
"last_email_clicked_at": 1571672154,
"language_override": "en",
"browser": "Chrome",
"browser_version": "80.0.3987.132",
"browser_language": "en-US",
"os": "Mac OS X",
"android_app_name": "Intercom",
"android_app_version": "5.0.0",
"android_device": "Pixel 3",
"android_os_version": "10",
"android_sdk_version": "28",
"android_last_seen_at": 1571672154,
"ios_app_name": "Intercom",
"ios_app_version": "5.0.0",
"ios_device": "iPhone 11",
"ios_os_version": "13.3.1",
"ios_sdk_version": "13.3.1",
"ios_last_seen_at": 1571672154,
"custom_attributes": {},
"avatar": {
"type": "avatar",
"image_url": "https://example.org/128Wash.jpg"
},
"tags": {
"data": [
{
"type": "note",
"id": "123",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/tags",
"total_count": 100,
"has_more": true
},
"notes": {
"data": [
{
"type": "note",
"id": "123",
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}
],
"url": "/contacts/5ba682d23d7cf92bef87bfd4/notes",
"total_count": 100,
"has_more": true
},
"companies": {
"url": "/contacts/5ba682d23d7cf92bef87bfd4/companies",
"total_count": 100,
"has_more": true
},
"location": {
"type": "location",
"country": "Ireland",
"region": "Dublin",
"city": "Dublin"
},
"social_profiles": {
"data": [
{
"type": "social_profile",
"name": "Facebook",
"url": "http://twitter.com/th1sland"
}
]
}
}
],
"total_count": 100,
"pages": {
"type": "pages",
"page": 1,
"next": {
"per_page": 2,
"starting_after": "your-cursor-from-response"
},
"per_page": 2,
"total_pages": 13
}
}
}
List Tags
List all Tags | key: listTags
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"data": {
"type": "list",
"data": [
{
"id": "17513",
"name": "independent",
"type": "tag"
}
]
}
}
List Ticket Types
Get a list of all ticket types for a workspace. | key: listTicketTypes
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"data": {
"type": "list",
"data": [
{
"type": "ticket_type",
"id": "126",
"name": "Bug Report",
"description": "Bug Report Template",
"icon": "🎟️",
"workspace_id": "this_is_an_id608_that_should_be_at_least_",
"archived": false,
"created_at": 1717022435,
"updated_at": 1717022435,
"is_internal": false,
"ticket_type_attributes": {
"type": "list",
"data": [
{
"type": "ticket_type_attribute",
"id": "354",
"workspace_id": "this_is_an_id608_that_should_be_at_least_",
"name": "_default_title_",
"description": "",
"data_type": "string",
"input_options": {
"multiline": false
},
"order": 0,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": true,
"default": true,
"ticket_type_id": 126,
"archived": false,
"created_at": 1717022435,
"updated_at": 1717022435
},
{
"type": "ticket_type_attribute",
"id": "356",
"workspace_id": "this_is_an_id608_that_should_be_at_least_",
"name": "name",
"description": "description",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": false,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 126,
"archived": false,
"created_at": 1717022435,
"updated_at": 1717022435
},
{
"type": "ticket_type_attribute",
"id": "355",
"workspace_id": "this_is_an_id608_that_should_be_at_least_",
"name": "_default_description_",
"description": "",
"data_type": "string",
"input_options": {
"multiline": true
},
"order": 1,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": true,
"default": true,
"ticket_type_id": 126,
"archived": false,
"created_at": 1717022435,
"updated_at": 1717022435
}
]
},
"category": "Customer"
}
]
}
}
Raw Request
Send a raw request to Intercom | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | This is the URL to call. | /sobjects/Account |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Retrieve a ticket
Retrieve a ticket by ID | key: getTicket
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Ticket ID | ID of the ticket to retrieve. | 5ba682d23d7cf92bef87bfd4 |
{
"data": {
"type": "ticket",
"id": "777",
"ticket_id": "39",
"ticket_attributes": {
"_default_title_": "attribute_value",
"_default_description_": null
},
"ticket_state": "submitted",
"ticket_state_internal_label": "Submitted",
"ticket_state_external_label": "Submitted",
"ticket_type": {
"type": "ticket_type",
"id": "153",
"name": "my-ticket-type-21",
"description": "my ticket type description is awesome.",
"icon": "🦁",
"workspace_id": "this_is_an_id660_that_should_be_at_least_",
"archived": false,
"created_at": 1717022478,
"updated_at": 1717022478,
"is_internal": false,
"ticket_type_attributes": {
"type": "list",
"data": [
{
"type": "ticket_type_attribute",
"id": "404",
"workspace_id": "this_is_an_id660_that_should_be_at_least_",
"name": "_default_title_",
"description": "ola",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": true,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 153,
"archived": false,
"created_at": 1717022478,
"updated_at": 1717022478
},
{
"type": "ticket_type_attribute",
"id": "405",
"workspace_id": "this_is_an_id660_that_should_be_at_least_",
"name": "_default_description_",
"description": "ola",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": true,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 153,
"archived": false,
"created_at": 1717022479,
"updated_at": 1717022479
}
]
},
"category": "Back-office"
},
"contacts": {
"type": "contact.list",
"contacts": [
{
"type": "contact",
"id": "6657af0f6abd0167d9419df3",
"external_id": "2274eea8-d400-48f6-9345-2fb84a96e94d"
}
]
},
"admin_assignee_id": "0",
"team_assignee_id": "0",
"created_at": 1717022479,
"updated_at": 1717022479,
"ticket_parts": {
"type": "ticket_part.list",
"ticket_parts": [
{
"type": "ticket_part",
"id": "208",
"part_type": "ticket_state_updated_by_admin",
"ticket_state": "submitted",
"previous_ticket_state": "submitted",
"created_at": 1717022479,
"updated_at": 1717022479,
"author": {
"id": "991268868",
"type": "admin",
"name": "Ciaran445 Lee",
"email": "admin445@email.com"
},
"attachments": [],
"redacted": false
}
],
"total_count": 1
},
"open": true,
"linked_objects": {
"type": "list",
"data": [],
"total_count": 0,
"has_more": false
},
"category": "Back-office",
"is_shared": false
}
}
Search Contacts
Search through all Contacts | key: searchContacts
| Input | Notes | Example |
|---|---|---|
| Connection | ||
Email of the contact | ||
| JSON Query | If you wanted to provide a custom query instead of the one constructed by the action, you can use this input to bypass it. | |
| Name | Name of the contact | |
| Role | The role of the contact | |
| Starting After Cursor | If you want to get the next page of data in the batch, you must make a new request with the starting_after parameter equal to the cursor pointer string. Use the starting_after parameter of the previous response. |
Unarchive Contact
Unarchive an archived Contact | key: unarchiveContact
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Contact ID | Unique identifier for the entity given by Intercom |
{
"data": {
"id": "5ba682d23d7cf92bef87bfd4",
"object": "contact",
"archived": false
}
}
Update Company
Update an existing Company | key: updateCompany
| Input | Notes | Example |
|---|---|---|
| Company ID | Identifier of Company | |
| Connection | ||
| Industry | The industry this company operates in | |
| Monthly Spend | How much revenue the company generates for your business | |
| Name | Name of the contact | |
| Plan | Name of the plan associated with the company | |
| Remote Created At | Time the company was created by you | |
| Size | Number of employees in this company | |
| Website | The URL for this company's website |
{
"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
| Input | Notes | Example |
|---|---|---|
| Avatar URL | An image URL containing the avatar of a contact | |
| Connection | ||
Email of the contact | ||
| External ID | Unique identifier for the entity from external systems | |
| Contact ID | Unique identifier for the entity given by Intercom | |
| Last Seen At | The time when the contact was last seen | |
| Name | Name of the contact | |
| Phone | Phone of the contact | |
| Role | The role of the contact | |
| Signed Up At | The time specified for when a contact signed up | |
| Unsubscribed From Emails | Whether the contact is unsubscribed from emails | false |
{
"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
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tag ID | ID of the tag | |
| Name | Name of the tag |
{
"data": {
"id": "17513",
"name": "independent",
"type": "tag"
}
}
Changelog
2025-08-15
- Added comprehensive data sources and inline data sources for companies, contacts, tags, tickets, and ticket types