Intercom¶
The Intercom modules 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 Ibexa Connect app
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Installing Ibexa Connect App in Intercom¶
1. Log in to your Intercom account.
2. Click App Store.
3. Search for Ibexa Connect app and install the Ibexa Connect app.
Connecting Intercom to Ibexa Connect¶
-
Log in to your Intercom account.
-
Go to your Ibexa Connect 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.
Contacts¶
List Contacts¶
Retrieves all your contacts (users and leads).
| Limit | Set the maximum number of contacts Ibexa Connect should return during one execution cycle. |
Get a Contact¶
Retrieves a contact.
| Contact ID | Select or map the Contact ID whose details you want to retrieve. |
Create a Contact¶
Creates a new contact (user or lead).
| Role | Select or map the Contact ID whose details you want to retrieve. |
| External ID | Enter (map) an External ID |
| Enter (map) the email address of the contact. | |
| Phone | Enter (map) the contact's email address. |
| Name | Enter (map) the contact's name. |
| Avatar | Enter (map) the URL address of the contact's avatar. |
| Last Seen At | Enter (map) the date and time when the contact was last active. |
| Signed Up At | Enter (map) the date and time when the contact signed up in the system. |
| Owner ID | Enter (map) the Owner ID of the contact. |
Update a Contact¶
Updates a contact.
| Contact ID | Select or ma the Contact ID whose details you want to update. |
| Role | Select or map the Contact ID whose details you want to retrieve. |
| External ID | Enter (map) an External ID |
| Enter (map) the email address of the contact. | |
| Phone | Enter (map) the contact's email address. |
| Name | Enter (map) the contact's name. |
| Avatar | Enter (map) the URL address of the contact's avatar. |
| Last Seen At | Enter (map) the date and time when the contact was last active. |
| Signed Up At | Enter (map) the date and time when the contact signed up in the system. |
| Owner ID | Enter (map) the Owner ID of the contact. |
Delete a Contact¶
Deletes a contact.
| Contact ID | Select or map the Contact ID you want to delete. |
Merge a Lead into a User¶
Merges a lead into a user.
| Lead ID | Select or map the Lead ID you want to merge into a user. This contact (lead) will be deleted after merging. |
| User ID | 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. |
List a Contact's Companies¶
Retrieves the list of companies associated with a contact.
| Contact ID | Select or map the Contact ID whose companies you want to list. |
| Limit | Set the maximum number of companies Ibexa Connect should return during one execution cycle. |
List a Contact's Tags¶
Retrieves the list of tags associated with a contact.
| Contact ID | Select or map the Contact ID whose tags you want to list. |
| Limit | Set the maximum number of tags Ibexa Connect should return during one execution cycle. |
List a Contact's Segments¶
Retrieves all segments that belong to a contact.
| Contact ID | Select or map the Contact ID whose segments you want to list. |
| Limit | Set the maximum number of segments Ibexa Connect should return during one execution cycle. |
Get a Contact's Note¶
Retrieves a note associated with a contact.
| Contact ID | Select or map the Contact ID whose note details you want to retrieve. |
| Note ID | Select or map the Note ID whose details you want to retrieve. |
Companies¶
List Companies¶
Retrieves all companies with associated users.
Order |
Select or map the order in which you want to list the companies:
|
Filter by |
Select or map the option to filter the companies based on the specified filter:
|
Segment ID |
Select or map the Segment ID to filter the companies based on the specified segment. |
Tag ID |
Select or map the Tag ID to filter the companies based on the specified tag. |
Limit |
Set the maximum number of companies Ibexa Connect should return during one execution cycle. |
List Companies (Large Datasets)¶
Retrieves all companies. This module is a variant of the List Companies module and is intended for large datasets.
| Limit | Set the maximum number of companies Ibexa Connect should return during one execution cycle. |
Get a Company¶
Retrieves a company.
| Select Company | Select or map the option to choose the method for retrieving the company details. |
| Company Name | Select or map the company name whose details you want to retrieve. |
| External Company ID | Select or map the External Company ID whose details you want to retrieve. |
Create or Update a Company¶
Creates or updates a company.
| Company ID | 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. |
| Name | Enter (map) the company name. |
| Plan | Enter (map) the plan in which you want to add the company. |
| Remote Created At | Enter (map) the date and time at which you are creating the company in the system. |
| Number of Employees | Enter (map) the number of employees working in the company. |
| Monthly Revenue | Enter (map) the monthly revenue of the company. The value must be lower than or equal to 2147483647. |
| Website | Enter (map) the URL address of the company. |
| Industry | Enter (map) the industry in which the company does business. For example, automobiles. |
| Custom Attributes | Add the custom attributes of the company. For example, Date of the establishment. |
List a Company's Contacts¶
Retrieves all contacts attached to a company.
| Internal Company ID | Select or map the Company ID to list the specified company's contacts. |
| Order | Select or map the order in which you want to list the contacts. |
| Limit | Set the maximum number of contacts Ibexa Connect should return during one execution cycle. |
List a Contact's Segments¶
Retrieves all segments that belong to a company.
| Contact ID | Select or map the Contact ID whose segments you want to list. |
| Order | Select or map the order in which you want to list the segments. |
| Limit | Set the maximum number of segments Ibexa Connect should return during one execution cycle. |
Attach or Depatch a Company to/from a Contact¶
Attaches or detaches a company from a user.
Attach or Detach |
Select or map the action you want to perform:
|
Internal Company ID |
Select or map the Internal Company ID you want to attach or detach from the contact. |
Contact ID |
Select or map the Contact ID from which you want to attach or detach a contact. |
Admins¶
List Admins¶
Retrieves all your admins.
| Limit | Set the maximum number of admins Ibexa Connect should return during one execution cycle. |
Get an Admin¶
Retrieves an admin.
| Admin ID | Select or map the Admin ID whose details you want to retrieve. |
Set an Admin as Away¶
Sets an admin on "away" for the inbox.
| Admin ID | Select or map the Admin ID whose status you want to set as away. |
| Away Mode Enabled | Select the checkbox to enable the status of the admin to away mode. |
| Away Mode Reassign | Select whether you want to assign any new conversation replies to your default inbox. |
List Activity Logs¶
Retrieves a log of activities by all admins.
| Created At After | Enter (map) the date and time to list the activity logs that were created on or after the specified date. |
| Created At Before | Enter (map) the date and time to list the activity logs that were created on or before the specified date. |
| Limit | Set the maximum number of activity logs Ibexa Connect should return during one execution cycle. |
Data Events¶
List a Contact's Data Events¶
Retrieves a contact's events from the last 90 days.
Select Contact |
Select or map the method to choose the contact whose events you want to list for the last 90 days:
|
Contact ID |
Select or map the Contact ID whose data events you list. |
Summary |
Select whether you want to group the event count returns by event name. |
Limit |
Set the maximum number of data events Ibexa Connect should return during one execution cycle. |
Submit a Contact's Event¶
Submits a contact event.
Event Name |
Enter (map) an event name. |
Created At |
Enter (map) the date and time when the event is created. |
Contact ID |
Select or map the Contact ID whose event you want to submit. |
Metadata Source |
Select or map the option to add the metadata:
|
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: |
Data Attributes¶
List Data Attributes¶
Retrieves the data attributes of the contact or company entity.
| Model | Select or map the model whose data attributes you want to list. |
| Include Archived | Select whether you want to include the archived data attributes in the output. |
| Limit | Set the maximum number of data attributes Ibexa Connect should return during one execution cycle. |
Create or Update a Data Attribute¶
Creates or updates a data attribute for contacts or companies.
Create or Update Data Attribute |
Select or map the action you want to perform:
|
Contact or Company Data Attribute |
Select or map the option of the data attribute:
|
Data Type |
Select or map the data type:
|
Name |
Enter (map) a name for the data attribute. |
Label |
Enter (map) an applicable label for the attribute. |
Description |
Enter (map) the details of the data attribute. |
Options |
Add the options, if the type of the data attribute is |
Archived |
Select whether you want to archive the data attribute. |
Tags¶
List Tags¶
Retrieves all your tags.
| Limit | Set the maximum number of tags Ibexa Connect should return during one execution cycle. |
Create or Update a tag¶
Creates or updates a tag.
| Tag Name | Enter (map) the tag's name. |
| Tag ID | Select or map the Tag ID you want to update otherwise leave this field blank. |
Delete a Tag¶
Deletes a tag.
| Tag ID | Select or map the Tag ID you want to delete. |
Attach or Detach a Tag to/from a Company¶
Attaches or detaches a tag from a company.
Attach or Detach |
Select or map the action your want to perform:
|
Companies |
Select or map the company to which you want to attach or detach a tag. |
Tag Name |
Select or map the tag you want to attach or detach. |
Attach or Detach a Tag to/from a Conversation¶
Attaches or detaches a tag from a conversation.
Attach or Detach |
Select or map the action your want to perform:
|
Tag ID |
Select or map the Conversation ID to which you want to attach or detach a tag. |
Tag Name |
Select or map the tag you want to attach or detach. |
Admin ID |
Select or map the Admin ID who is attaching or detaching the tag. |
Attach or Detach a Tag to/from a Contact¶
Attaches or detaches a tag from a user.
Attach or Detach |
Select or map the action your want to perform:
|
Tag ID |
Select or map the Tag ID you want to attach or detach from the contact. |
Contact ID |
Select or map the Contact ID from which you want to attach or detach the tag. |
Segments¶
List Segments¶
Retrieves all your segments.
Type |
Select or map the Segment type:
|
Limit |
Set the maximum number of segments Ibexa Connect should return during one execution cycle. |
Get a Segment¶
Retrieves a segment.
Type |
Select or map the segment type:
|
Segment ID |
Select or map the Segment ID whose details you want to retrieve. |
Notes¶
List a Contact's Notes¶
Retrieves all notes associated with a contact.
| Contact ID | Select or map the Contact ID whose notes you want to list. |
| Limit | Set the maximum number of notes Ibexa Connect should return during one execution cycle. |
Create a Contact Note¶
Creates a note associated with a contact.
| Contact ID | Select or map the Contact ID whose notes you want to list. |
| Text | Enter (map) the note's text you want to add to the contact. |
| Admin ID | Select or map the Admin ID who is adding the note. |
Conversations¶
List Conversations¶
Retrieves all your conversations.
Order |
Select or map the order in which you want to sort the conversations:
|
Sort By |
Select or map the option to sort the conversations:
|
Before Date |
Enter (map) a date to search the conversations created or updated before the specified date. |
Limit |
Set the maximum number of segments Ibexa Connect should return during one execution cycle. |
Search for a Conversation¶
Searches for conversations matching a query.
Single or Multiple Filter |
Select the filters you want to add to search the conversations:
|
Operator |
Select or map the operator. For example, Equals to, Not Equals. |
Field |
Select or map the field. For example, Tag ID. |
Value |
Enter (map) the value to apply the filter. For example, tag name. |
Get a Conversation¶
Retrieves a conversation.
| Conversation ID | Select or map the Conversation ID whose details you want to update. |
Create a Contact Initiated Conversation¶
Create a conversation initiated by a user or lead.
| Contact ID | 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. |
| Message Body | Enter (map) the body text. |
Create an Admin Initiated Conversation¶
Creates a message for an in-app conversation or email conversation.
Message Type |
Select or map the message type:
|
Message Body |
Enter (map) the body text. |
From Admin ID |
Select or map the Admin ID who is initiating the conversation. |
To Contact ID |
Select or map the Contact ID to whom you want to assign a conversation. |
Assign a Conversation¶
Assigns a conversation to an admin or team.
Conversation |
Enter (map) the conversation you want to assign to an admin or team. |
Assignment Options |
Select or map the assignment options:
|
Assignee |
Select or map the assignee to whom you want to assign the conversation. |
Admin |
Select or map the admin to whom you want to assign the conversation. |
Note |
Enter (map) the note for assigning the conversation. |
Attach or Detach a Contact to/from a Conversation¶
Attaches or detaches a contact from a conversation.
Attach or Detach |
Select or map the action you want to perform:
|
Admin or Contact |
Select or map the admin or contact as a conversation participant on behalf of either another contact or an admin. |
Admin ID |
Select or map the Admin ID to add as a conversation participant. |
Contact ID |
Select or map the Contact ID to add as a conversation participant. |
Select Contact |
Select or map the option to select the customer to add the conversation:
|
Contact ID |
Select or map the Contact ID to whom you want to send the conversation. |
Conversation ID |
Enter (map) the conversation ID you want to attach or detach. |
Limit |
Set the maximum number of conversations Ibexa Connect should return during one execution cycle. |
Mark a Conversation as Read¶
Marks a conversation as read.
| Conversation ID | Select or map the Conversation ID which you want to mark as read. |
Reply to a Conversation¶
Replies to a conversation with a message on behalf of contact or admin or with a note for admins.
Type |
Select or map the reply type:
|
Message Type |
Select or map message type you want to send:
|
Conversation or Contact's Last Conversation |
Select or map the conversation type:
|
Contact ID |
Select or map the Contact ID associated with the conversation. |
Admin ID |
Select or map the Admin ID associated with the conversation. |
Select Contact |
Select or map the option to select the customer to add the conversation:
|
Contact ID |
Select or map the Contact ID associated with the conversation. |
Message |
Enter (map) the reply message text. |
Attachment URL's |
Add the attachment's URL address that you want to send with the reply: |
Snooze a Conversation¶
Snoozes a conversation to reopen on a future date.
| Conversation | Select or map the conversation you want to snooze. |
| Admin ID | Select or map the Admin ID who is snoozing the conversation |
| Snoozed Until | Enter (map) the time in seconds until which you want to snooze the conversation. |
Close a Conversation¶
Closes a conversation.
| Conversation | Select the conversation you want to close. |
| Admin | Select the admin who is authoring the conversation. |
| Message | Enter the message for closing the conversation. |
Open a Snoozed or Closed Conversation¶
Open a snoozed or closed conversation.
| Conversation | Select the conversation you want to open. |
| Admin | Select the admin who is opening the conversation. |
Update a Conversation's Custom Attributes¶
Updates the custom attributes of a conversation.
| Conversation ID | Select the conversation you want to update. |
| Custom Attributes | Add the custom attributes for the conversation to update. |
Other¶
Watch Events¶
Receives notifications for all events.
| Webhook Name | Enter a name for the webhook. |
For more information, see Intercom Webhooks.
Get the Authenticated User¶
Retrieves the authenticated user.
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Intercom API Documentation. |
Method
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.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example - List Segments¶
The following API call returns all the segments from your Intercom account.
Matches of the search can be found in the module's Output under Bundle > Body > segments. In our example, 5 segments were returned:
