- Intercom
- Installing Boost.space Integrator App in Intercom
- Connecting Intercom to Boost.space Integrator
- Contacts
- Companies
- Admins
- Data Events
- Data Attributes
- Tags
- Segments
- Notes
- Conversations
- List Conversations
- Search for a Conversation
- Get a Conversation
- Create a Contact Initiated Conversation
- Create an Admin Initiated Conversation
- Assign a Conversation
- Attach or Detach a Contact to/from a Conversation
- Mark a Conversation as Read
- Reply to a Conversation
- Snooze a Conversation
- Close a Conversation
- Open a Snoozed or Closed Conversation
- Update a Conversation's Custom Attributes
- Other
| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your connection. |
The Intercom integrator. Designed to work with data inside the application.']module[/tooltip]s allow you to watch, create, update, list, and/or delete admins, companies, conversations, events, leads, notes, segments, tags, and users in your Intercom account.
Prerequisites
-
An Intercom account – create an account at https://www.intercom.com/.
-
Install Boost.space Integrator app
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
1. Log in to your Intercom account.
2. Click App Store.
3. Search for Boost.space Integrator app and install the Boost.space Integrator app.
-
Log in to your Intercom account.
-
Go to your Boost.space Integrator scenario and select the Intercom module you want to use.
-
Next to Connection, Click Add.
-
Choose a name for your connection, than click Save.
-
Confirm the dialog by clicking Authorize access.
You have successfully established the connection.
Retrieves all your contacts (users and leads).
|
|
|
|
|
Set the maximum number of contacts Boost.space Integrator should return during one execution cycle. |
Retrieves a contact.
|
|
|
|
|
Select or map the Contact ID whose details you want to retrieve. |
Creates a new contact (user or lead).
|
|
|
|
|
Select or map the Contact ID whose details you want to retrieve. |
|
|
Enter (map) an External ID |
|
|
Enter (map) the email address of the contact. |
|
|
Enter (map) the contact’s email address. |
|
|
Enter (map) the contact’s name. |
|
|
Enter (map) the URL address of the contact’s avatar. |
|
|
Enter (map) the date and time when the contact was last active. |
|
|
Enter (map) the date and time when the contact signed up in the system. |
|
|
Enter (map) the Owner ID of the contact. |
Updates a contact.
|
|
|
|
|
Select or ma the Contact ID whose details you want to update. |
|
|
Select or map the Contact ID whose details you want to retrieve. |
|
|
Enter (map) an External ID |
|
|
Enter (map) the email address of the contact. |
|
|
Enter (map) the contact’s email address. |
|
|
Enter (map) the contact’s name. |
|
|
Enter (map) the URL address of the contact’s avatar. |
|
|
Enter (map) the date and time when the contact was last active. |
|
|
Enter (map) the date and time when the contact signed up in the system. |
|
|
Enter (map) the Owner ID of the contact. |
Deletes a contact.
|
|
|
|
|
Select or map the Contact ID you want to delete. |
Merges a lead into a user.
|
|
|
|
|
Select or map the Lead ID you want to merge into a user. This contact (lead) will be deleted after merging. |
|
|
Select or map the User ID with which you merge the lead. This contact (user) will remain. Attributes that don’t exist on this contact will be copied over from the lead contact. |
Retrieves the list of companies associated with a contact.
|
|
|
|
|
Select or map the Contact ID whose companies you want to list. |
|
|
Set the maximum number of companies Boost.space Integrator should return during one execution cycle. |
Retrieves the list of tags associated with a contact.
|
|
|
|
|
Select or map the Contact ID whose tags you want to list. |
|
|
Set the maximum number of tags Boost.space Integrator should return during one execution cycle. |
Retrieves all segments that belong to a contact.
|
|
|
|
|
Select or map the Contact ID whose segments you want to list. |
|
|
Set the maximum number of segments Boost.space Integrator should return during one execution cycle. |
Retrieves a note associated with a contact.
|
|
|
|
|
Select or map the Contact ID whose note details you want to retrieve. |
|
|
Select or map the Note ID whose details you want to retrieve. |
Retrieves all companies with associated users.
|
|
|
|
|
Select or map the order in which you want to list the companies:
|
|
|
Select or map the option to filter the companies based on the specified filter:
|
|
|
Select or map the Segment ID to filter the companies based on the specified segment. |
|
|
Select or map the Tag ID to filter the companies based on the specified tag. |
|
|
Set the maximum number of companies Boost.space Integrator should return during one execution cycle. |
Retrieves all companies. This module is a variant of the List Companies module and is intended for large datasets.
|
|
|
|
|
Set the maximum number of companies Boost.space Integrator should return during one execution cycle. |
Retrieves a company.
|
|
|
|
|
Select or map the option to choose the method for retrieving the company details. |
|
|
Select or map the company name whose details you want to retrieve. |
|
|
Select or map the External Company ID whose details you want to retrieve. |
Creates or updates a company.
|
|
|
|
|
Select or map the Company ID to update an existing company, to create a new company, use the map option and enter the new company name. |
|
|
Enter (map) the company name. |
|
|
Enter (map) the plan in which you want to add the company. |
|
|
Enter (map) the date and time at which you are creating the company in the system. |
|
|
Enter (map) the number of employees working in the company. |
|
|
Enter (map) the monthly revenue of the company. The value must be lower than or equal to 2147483647. |
|
|
Enter (map) the URL address of the company. |
|
|
Enter (map) the industry in which the company does business. For example, automobiles. |
|
|
Add the custom attributes of the company. For example, Date of the establishment. |
Retrieves all contacts attached to a company.
|
|
|
|
|
Select or map the Company ID to list the specified company’s contacts. |
|
|
Select or map the order in which you want to list the contacts. |
|
|
Set the maximum number of contacts Boost.space Integrator should return during one execution cycle. |
Retrieves all segments that belong to a company.
|
|
|
|
|
Select or map the Contact ID whose segments you want to list. |
|
|
Select or map the order in which you want to list the segments. |
|
|
Set the maximum number of segments Boost.space Integrator should return during one execution cycle. |
Attaches or detaches a company from a user.
|
|
|
|
|
Select or map the action you want to perform:
|
|
|
Select or map the Internal Company ID you want to attach or detach from the contact. |
|
|
Select or map the Contact ID from which you want to attach or detach a contact. |
Retrieves all your admins.
|
|
|
|
|
Set the maximum number of admins Boost.space Integrator should return during one execution cycle. |
Retrieves an admin.
|
|
|
|
|
Select or map the Admin ID whose details you want to retrieve. |
Sets an admin on “away” for the inbox.
|
|
|
|
|
Select or map the Admin ID whose status you want to set as away. |
|
|
Select the checkbox to enable the status of the admin to away mode. |
|
|
Select whether you want to assign any new conversation replies to your default inbox. |
Retrieves a log of activities by all admins.
|
|
|
|
|
Enter (map) the date and time to list the activity logs that were created on or after the specified date. |
|
|
Enter (map) the date and time to list the activity logs that were created on or before the specified date. |
|
|
Set the maximum number of activity logs Boost.space Integrator should return during one execution cycle. |
Retrieves a contact’s events from the last 90 days.
|
|
|
|
|
Select or map the method to choose the contact whose events you want to list for the last 90 days:
|
|
|
Select or map the Contact ID whose data events you list. |
|
|
Select whether you want to group the event count returns by event name. |
|
|
Set the maximum number of data events Boost.space Integrator should return during one execution cycle. |
Submits a contact event.
|
|
|
|
|
Enter (map) an event name. |
|
|
Enter (map) the date and time when the event is created. |
|
|
Select or map the Contact ID whose event you want to submit. |
|
|
Select or map the option to add the metadata:
|
|
|
Add the metadata: Key – Enter (map) the details of the key. For example, currency. Value – Enter (map) the value for the key. Value can be any type from Intercom Event Metadata types. For the types, Rich Link and **Monetary Amount**, enter JSON. For example: |
Retrieves the data attributes of the contact or company entity.
|
|
|
|
|
Select or map the model whose data attributes you want to list. |
|
|
Select whether you want to include the archived data attributes in the output. |
|
|
Set the maximum number of data attributes Boost.space Integrator should return during one execution cycle. |
Creates or updates a data attribute for contacts or companies.
|
|
|
|
|
Select or map the action you want to perform:
|
|
|
Select or map the option of the data attribute:
|
|
|
Select or map the data type:
|
|
|
Enter (map) a name for the data attribute. |
|
|
Enter (map) an applicable label for the attribute. |
|
|
Enter (map) the details of the data attribute. |
|
|
Add the options, if the type of the data attribute is |
|
|
Select whether you want to archive the data attribute. |
Retrieves all your tags.
|
|
|
|
|
Set the maximum number of tags Boost.space Integrator should return during one execution cycle. |
Creates or updates a tag.
|
|
|
|
|
Enter (map) the tag’s name. |
|
|
Select or map the Tag ID you want to update otherwise leave this field blank. |
Deletes a tag.
|
|
|
|
|
Select or map the Tag ID you want to delete. |
Attaches or detaches a tag from a company.
|
|
|
|
|
Select or map the action your want to perform:
|
|
|
Select or map the company to which you want to attach or detach a tag. |
|
|
Select or map the tag you want to attach or detach. |
Attaches or detaches a tag from a conversation.
|
|
|
|
|
Select or map the action your want to perform:
|
|
|
Select or map the Conversation ID to which you want to attach or detach a tag. |
|
|
Select or map the tag you want to attach or detach. |
|
|
Select or map the Admin ID who is attaching or detaching the tag. |
Attaches or detaches a tag from a user.
|
|
|
|
|
Select or map the action your want to perform:
|
|
|
Select or map the Tag ID you want to attach or detach from the contact. |
|
|
Select or map the Contact ID from which you want to attach or detach the tag. |
Retrieves all your segments.
|
|
|
|
|
Select or map the Segment type:
|
|
|
Set the maximum number of segments Boost.space Integrator should return during one execution cycle. |
Retrieves a segment.
|
|
|
|
|
Select or map the segment type:
|
|
|
Select or map the Segment ID whose details you want to retrieve. |
Retrieves all notes associated with a contact.
|
|
|
|
|
Select or map the Contact ID whose notes you want to list. |
|
|
Set the maximum number of notes Boost.space Integrator should return during one execution cycle. |
Creates a note associated with a contact.
|
|
|
|
|
Select or map the Contact ID whose notes you want to list. |
|
|
Enter (map) the note’s text you want to add to the contact. |
|
|
Select or map the Admin ID who is adding the note. |
Retrieves all your conversations.
|
|
|
|
|
Select or map the order in which you want to sort the conversations:
|
|
|
Select or map the option to sort the conversations:
|
|
|
Enter (map) a date to search the conversations created or updated before the specified date. |
|
|
Set the maximum number of segments Boost.space Integrator should return during one execution cycle. |
Searches for conversations matching a query.
|
|
|
|
|
Select the filters you want to add to search the conversations:
|
|
|
Select or map the operator. For example, Equals to, Not Equals. |
|
|
Select or map the field. For example, Tag ID. |
|
|
Enter (map) the value to apply the filter. For example, tag name. |
Retrieves a conversation.
|
|
|
|
|
Select or map the Conversation ID whose details you want to update. |
Create a conversation initiated by a user or lead.
|
|
|
|
|
Select or map the Contact ID to create the conversation. You can also use a visitor ID, this visitor will be automatically converted to contact with a lead role once the conversation is created. |
|
|
Enter (map) the body text. |
Creates a message for an in-app conversation or email conversation.
|
|
|
|
|
Select or map the message type:
|
|
|
Enter (map) the body text. |
|
|
Select or map the Admin ID who is initiating the conversation. |
|
|
Select or map the Contact ID to whom you want to assign a conversation. |
Assigns a conversation to an admin or team.
|
|
|
|
|
Enter (map) the conversation you want to assign to an admin or team. |
|
|
Select or map the assignment options:
|
|
|
Select or map the assignee to whom you want to assign the conversation. |
|
|
Select or map the admin to whom you want to assign the conversation. |
|
|
Enter (map) the note for assigning the conversation. |
Attaches or detaches a contact from a conversation.
|
|
|
|
|
Select or map the action you want to perform:
|
|
|
Select or map the admin or contact as a conversation participant on behalf of either another contact or an admin. |
|
|
Select or map the Admin ID to add as a conversation participant. |
|
|
Select or map the Contact ID to add as a conversation participant. |
|
|
Select or map the option to select the customer to add the conversation:
|
|
|
Select or map the Contact ID to whom you want to send the conversation. |
|
|
Enter (map) the conversation ID you want to attach or detach. |
|
|
Set the maximum number of conversations Boost.space Integrator should return during one execution cycle. |
Marks a conversation as read.
|
|
|
|
|
Select or map the Conversation ID which you want to mark as read. |
Replies to a conversation with a message on behalf of contact or admin or with a note for admins.
|
|
|
|
|
Select or map the reply type:
|
|
|
Select or map message type you want to send:
|
|
|
Select or map the conversation type:
|
|
|
Select or map the Contact ID associated with the conversation. |
|
|
Select or map the Admin ID associated with the conversation. |
|
|
Select or map the option to select the customer to add the conversation:
|
|
|
Select or map the Contact ID associated with the conversation. |
|
|
Enter (map) the reply message text. |
|
|
Add the attachment’s URL address that you want to send with the reply: |
Snoozes a conversation to reopen on a future date.
|
|
|
|
|
Select or map the conversation you want to snooze. |
|
|
Select or map the Admin ID who is snoozing the conversation |
|
|
Enter (map) the time in seconds until which you want to snooze the conversation. |
Closes a conversation.
|
|
|
|
|
Select the conversation you want to close. |
|
|
Select the admin who is authoring the conversation. |
|
|
Enter the message for closing the conversation. |
Open a snoozed or closed conversation.
|
|
|
|
|
Select the conversation you want to open. |
|
|
Select the admin who is opening the conversation. |
Updates the custom attributes of a conversation.
|
|
|
|
|
Select the conversation you want to update. |
|
|
Add the custom attributes for the conversation to update. |
Receives notifications for all events.
|
|
Enter a name for the webhook. |
|
|
For more information, see Intercom Webhooks.
Retrieves the authenticated user.
|
|
Performs an arbitrary authorized API call.
|
|
||||
|
|
Enter a path relative to
|
|||
|
|
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
|
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
|
Enter the request query string. |
|||
|
|
Enter the body content for your API call. |
Do you need help with something specific regarding Intercom?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch