Intercom
Intercom is a customer messaging and support platform. Connect to manage contacts, conversations, tags, and help-center articles from your AI workflows.
Connectors
Choose the connector that matches your authentication method. The options below use the names shown in StackAI.
Intercom
API Key
Intercom
Connect to Intercom API for managing customer conversations, contacts, and support resources.
Set up in Intercom
Sign in to the Intercom Developer Hub (developers.intercom.com) with your Intercom account.
Open your Developer Hub Dashboard and create a new app (or select an existing one) tied to the workspace you want to access.
Open the app's Authentication section and copy its Access Token. (Access Tokens are for accessing your own workspace; use OAuth if you are building a public integration.)
Set up in StackAI
Open Settings → Connections, add a connection, and select Intercom.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
API Key
Yes
Your Intercom Access Token. You can create one in the Developer Hub. Provider instructions.
Provider documentation: Setup reference.
Verify the connection
Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.
If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.
Use an action
Add the required Intercom action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
Run the workflow and inspect the action’s output. Check the result before using it in a later step.
Actions
Get Articles
Retrieve a list of articles from Intercom with pagination support.
Inputs
No input fields are required in this catalog entry.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Calls
Retrieve a paginated list of calls from Intercom.
Inputs
Page Number
number
No
Page number to retrieve (defaults to first page). Default: 1.
Results Per Page
number
No
Number of results per page (max 25). Default: 25.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Company Contacts
Retrieve a list of contacts that belong to a specific company from Intercom.
Inputs
Company ID
string
Yes
Enter the company ID to get its contacts.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Contact
Get a single contact from Intercom by their ID.
Inputs
Contact ID
string
Yes
Enter the contact ID to retrieve.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Contacts
Retrieve a paginated list of all contacts from Intercom.
Inputs
No input fields are required in this catalog entry.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Update Contact
Update a contact in Intercom with new information.
Inputs
Contact ID
string
Yes
Enter the contact ID to update.
string
No
Enter the contact's email address.
Name
string
No
Enter the contact's name.
Phone
string
No
Enter the contact's phone number.
Custom Attributes
object
No
Enter custom attributes as key-value pairs.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Tag Contact
Add a tag to a contact in Intercom.
Inputs
Contact ID
string
Yes
Enter the contact ID to tag.
Tag ID
string
Yes
Enter the tag ID to add to the contact.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Untag Contact
Remove a tag from a contact in Intercom.
Inputs
Contact ID
string
Yes
Enter the contact ID to untag.
Tag ID
string
Yes
Enter the tag ID to remove from the contact.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Search Articles
Search for articles in Intercom help center
Inputs
Phrase
string
Yes
The phrase to search for in the articles.
State
string
No
The state of the Articles returned. One of published, draft or all. Default: published.
Help Center ID
select (integer)
Yes
The ID of the Help Center to search in. Options load from the selected connection.
Max Articles
number
No
Maximum number of articles to return. Must be a positive integer. The number of relevant articles may be less than k. Default: 3.
Outputs
Articles
dict_array
List of articles found in the search results.
Get Conversation
Retrieve a specific conversation from Intercom with full details including conversation parts.
Inputs
Conversation ID
integer
Yes
Enter the conversation ID to retrieve.
Display Format
string
No
Choose how to display conversation messages.
Include Translations
boolean
No
Include translations for conversation parts.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Conversations
Retrieve a paginated list of conversations from Intercom with filtering options.
Inputs
Results Per Page
integer
No
Enter the number of conversations to return per page.
Starting After
string
No
Enter the cursor string to get the next page of conversations.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Create Conversation
Create a new conversation in Intercom with an initial message.
Inputs
From Contact
object
Yes
Enter the contact details to start the conversation.
Message Body
string
Yes
Enter the message content.
Created At
integer
No
Enter the creation timestamp (optional).
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Update Conversation
Update an existing conversation in Intercom with custom attributes and other properties.
Inputs
Conversation ID
integer
Yes
Enter the conversation ID to update.
Display Format
string
No
Choose how to display conversation messages.
Mark as Read
boolean
No
Mark the conversation as read.
Conversation Title
string
No
Enter a new title for the conversation.
Custom Attributes
object
No
Enter custom attributes as key-value pairs.
Company ID
string
No
Enter the company ID to associate with the conversation.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Delete Conversation
Permanently delete a conversation from Intercom.
Inputs
Conversation ID
integer
Yes
Enter the conversation ID to delete.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Search Conversations
Search conversations in Intercom with advanced filtering and complex query options.
Inputs
Search Query
object
Yes
Define your search filters using a query object.
Pagination
object
No
Specify pagination options like results per page and starting cursor.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Tag Conversation
Add a tag to a specific conversation in Intercom.
Inputs
Conversation ID
string
Yes
Enter the conversation ID to tag.
Tag ID
string
Yes
Enter the tag ID to apply to the conversation.
Admin ID
string
Yes
Enter the admin ID who is applying the tag.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Untag Conversation
Remove a specific tag from a conversation in Intercom.
Inputs
Conversation ID
string
Yes
Enter the conversation ID to remove the tag from.
Tag ID
string
Yes
Enter the tag ID to remove from the conversation.
Admin ID
string
Yes
Enter the admin ID who is removing the tag.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Enqueue Reporting Data Export
Start a new reporting data export job in Intercom.
Inputs
Dataset ID
string
Yes
Enter the dataset ID to export.
Attribute IDs
string_array
Yes
Enter the attribute IDs to include in the export.
Start Time
integer
Yes
Enter the start time as Unix timestamp.
End Time
integer
Yes
Enter the end time as Unix timestamp.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Reporting Data Status
Check the status of a reporting data export job in Intercom.
Inputs
Job Identifier
string
Yes
Enter the job identifier to check status.
App ID
string
Yes
Enter the app ID.
Client ID
string
Yes
Enter the client ID.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Get Reporting Datasets
List available datasets and attributes for reporting data export in Intercom.
Inputs
No input fields are required in this catalog entry.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Download Reporting Data
Download completed reporting data export from Intercom.
Inputs
Job Identifier
string
Yes
Enter the job identifier to download.
App ID
string
Yes
Enter the app ID.
Outputs
Status Code
integer
Status code of the response.
Headers
dict
Headers of the response.
Body
object
Body of the response.
Important behavior
Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.
The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.
Last updated
Was this helpful?