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.

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.

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

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.

InputNotes
Access Token
password
/ Required
accessToken
Access Token for Intercom

Actions​

Archive Contact​

Archive an existing Contact | key: archiveContact

InputNotes
Connection
connection
/ Required
connection
 
ID
string
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

InputNotes
Company ID
string
/ Required
companyId
Identifier of Company
Connection
connection
/ Required
connection
 
ID
string
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

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

Create Company​

Create a new Company | key: createCompany

InputNotes
Company ID
string
/ Required
company_id
Identifier of Company
Connection
connection
/ Required
connection
 
Industry
string
industry
The industry this company operates in
Monthly Spend
string
monthly_spend
How much revenue the company generates for your business
Name
string
/ Required
name
Name of the company
Plan
string
plan
Name of the plan associated with the company
Remote Created At
string
/ Required
remote_created_at
Time the company was created by you
Size
string
size
Number of employees in this company
Website
string
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

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

{
  "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
Connection
connection
/ Required
connection
 
Name
string
/ Required
name
Name of the tag

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

Create Ticket​

Create a new Ticket | key: createTicket

InputNotesExample
Company ID
string
companyId
The ID of the company that the ticket is associated with. The ID that you set upon company creation.
147
Connection
connection
/ Required
connection
 
 
Contact ID
string
/ Required
contactId
The ID / email / external Id of the user affected by this ticket.
6657af026abd0167d9419def
Ticket Attributes
code
ticketAttributes
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
string
/ Required
ticketTypeId
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

InputNotes
Connection
connection
/ Required
connection
 
Company ID
string
/ Required
id
Identifier of Company

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

Delete Contact​

Delete an existing Contact | key: deleteContact

InputNotes
Connection
connection
/ Required
connection
 
ID
string
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

InputNotes
Connection
connection
/ Required
connection
 
Tag ID
string
/ Required
id
ID of the tag

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

Detach Company from Contact​

Detach Company from Contact | key: detachCompany

InputNotes
Company ID
string
/ Required
companyId
Identifier of Company
Connection
connection
/ Required
connection
 
ID
string
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

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

Get Company​

Retrieves an existing Company | key: getCompany

InputNotes
Connection
connection
/ Required
connection
 
Company ID
string
/ Required
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

InputNotes
Connection
connection
/ Required
connection
 
ID
string
/ Required
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

InputDefaultNotesExample
Company ID
string
companyId
Id of the company to be used as filter.
147
Name
string
companyName
Name of the company to be used as filter.
 
Connection
connection
/ Required
connection
 
 
 
Fetch All
boolean
fetchAll
false
If true, all pages of results will be fetched.
 
Order
string
order
desc
The order to sort the results in. Default is 'desc'.
 
Page
string
page
The page of results to fetch.
1
Per Page
string
perPage
How many results to return per page. Default is 15. Max is 50.
15
Segment ID
string
segmentId
Id of the segment to be used as filter.
 
Starting After Cursor
string
startingAfter
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
string
tagId
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

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Fetch All
boolean
fetchAll
false
If true, all pages of results will be fetched.
 
Order
string
order
desc
The order to sort the results in. Default is 'desc'.
 
Page
string
page
The page of results to fetch.
1
Per Page
string
perPage
How many results to return per page. Default is 15. Max is 50.
15
Starting After Cursor
string
startingAfter
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

InputNotes
Connection
connection
/ Required
connection
 

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

List Ticket Types​

Get a list of all ticket types for a workspace. | key: listTicketTypes

InputNotes
Connection
connection
/ Required
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

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
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
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
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.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
This is the URL to call.
/sobjects/Account
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

Search Contacts​

Search through all Contacts | key: searchContacts

InputNotes
Connection
connection
/ Required
connection
 
Email
string
email
Email of the contact
JSON Query
code
jsonQuery
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
string
name
Name of the contact
Role
string
role
The role of the contact
Starting After Cursor
string
startingAfter
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

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

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

Update Company​

Update an existing Company | key: updateCompany

InputNotes
Company ID
string
/ Required
company_id
Identifier of Company
Connection
connection
/ Required
connection
 
Industry
string
industry
The industry this company operates in
Monthly Spend
string
monthly_spend
How much revenue the company generates for your business
Name
string
name
Name of the contact
Plan
string
plan
Name of the plan associated with the company
Remote Created At
string
remote_created_at
Time the company was created by you
Size
string
size
Number of employees in this company
Website
string
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

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

{
  "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
Connection
connection
/ Required
connection
 
Tag ID
string
/ Required
id
ID of the tag
Name
string
/ Required
name
Name of the tag

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