# Intercom

Intercom offers a comprehensive customer messaging platform for sales, marketing, and support.

The platform offers a wide range of capabilities:

**Add Note**

Add a note to a user

**Add a note to a conversation**

Add a note (for other admins) to an existing conversation

**Add/Remove Tag on Contact**

Attach or remove a tag from a specific contact.

**Add/Remove Tag on Company**

Attach or remove a tag from a specific company.

**Add/Remove Tag on Conversation**

Attach or remove a tag from a specific conversation.

**Create Article**

Creates a new article in your Help Center.

**Create Conversation**

Creates a new conversation from a contact.

**Create Ticket**

Creates a new ticket.

**Create User**

Creates a new user.

**Create or Update Lead**

Create or update an Intercom lead. If an ID is provided, the lead will be updated.

**Create/Update User**

Update a user within Intercom given an email address.

**Reply to conversation**

Reply (as an admin) to a conversation with a contact

**Send Message**

Send a message to a contact (only allowed by admins)

**Update Ticket**

Updates an existing ticket.

**Find Company**

Finds an existing company.

**Find Conversation**

Searches for conversations using various criteria

**Find Lead**

Finds an existing lead.

**Find User**

Finds an existing user.

**List Tags**

List all tags.

**Retrieve a Conversation**

Retrieves a specific conversation by ID.

**Custom API Call**

Make a custom API call to a specific endpoint

#### **How to Connect Intercom to ZBrain Flow?** <a href="#how-to-connect-intercom-to-zbrain-flow" id="how-to-connect-intercom-to-zbrain-flow"></a>

To integrate Intercom with ZBrain Flow, follow these steps to select and utilize the desired capabilities:

1. **Search for the Intercom Component**: Search the Intercom component within the ZBrain interface.
2. **Select the Required Capability**: Select the desired capability as per your requirement.

#### **Additional Settings to Add Note** <a href="#additional-settings-to-add-note" id="additional-settings-to-add-note"></a>

This action allows users to add notes to customer profiles in Intercom, aiding in communication tracking and enhancing customer relationship management.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Email**\* - Enter the email address of the customer to whom the note will be added.
3. **Note Text**\* - Provide the text of the note that you want to add to the customer's profile.

#### **Additional Settings to Add Note to Conversation** <a href="#additional-settings-to-add-note-to-conversation" id="additional-settings-to-add-note-to-conversation"></a>

This action enables users to add notes to specific conversations in Intercom, providing context or important information directly within the conversation stream.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **From (Admin)**\* - Specify the administrator's account from which the note will be added. This field typically requires prior connection to your account to populate correctly.
3. **Conversation ID**\* - Enter the ID of the conversation to which you want to add a note.
4. **Message Body**\* - Provide the text of the note that you want to add to the conversation.

#### **Additional Settings to Add/Remove Tag on Contact and Company** <a href="#additional-settings-to-add-remove-tag-on-contact-and-company" id="additional-settings-to-add-remove-tag-on-contact-and-company"></a>

This action enables users to either add or remove tags from contacts in Intercom, facilitating efficient segmentation and management of customer interactions based on specific tags.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Contact ID**\* - Enter the ID of the contact to whom the tag will be added or from whom it will be removed.
3. **Company ID:** Enter the company ID and connect your account.
4. **Tag Name**\* - Specify the name of the tag to add or remove.

**Optional Fields**

4. **Untag?** - Check this box if you intend to remove the tag from the contact, otherwise, the action will add the tag.

&#x20;

#### **Additional Settings to Add/Remove Tag on Conversation** <a href="#additional-settings-to-add-remove-tag-on-conversation" id="additional-settings-to-add-remove-tag-on-conversation"></a>

This action allows users to manage tags associated with specific conversations in Intercom, aiding in categorizing and tracking conversations for better customer engagement and support analysis.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Conversation ID**\* - Enter the ID of the conversation to which you want to add or remove a tag.
3. **Tag**\* - Specify the tag to add or remove from the conversation.

**Optional Fields**

4. **Untag?** - Check this box if you wish to remove the tag from the conversation, otherwise the tag will be added.

&#x20;

#### **Additional Settings to Create Article** <a href="#additional-settings-to-create-article" id="additional-settings-to-create-article"></a>

This action enables users to create and manage articles within Intercom's help center, allowing for the effective dissemination of information and support resources to users.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Title**\* - Enter the title of the article you wish to create.
3. **Author**\* - Specify the author of the article. This field typically requires a prior connection to your account to populate correctly.
4. **State**\* - Choose the publication state of the article, such as 'Draft' or 'Published'.

**Optional Fields**

5. **Description** - Provide a short description or summary of the article.
6. **Body** - Enter the main content of the article.
7. **Parent Collection** - Specify the collection within the help center where this article should be categorized.

#### **Additional Settings to Create Conversation** <a href="#additional-settings-to-create-conversation" id="additional-settings-to-create-conversation"></a>

This action allows users to initiate new conversations in Intercom directly, facilitating immediate communication with customers or users based on specified criteria.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Contact Type**\* - Choose the type of contact you are initiating a conversation with, typically 'User' or 'Lead'.
3. **Contact ID**\* - Specify the ID of the contact with whom you are starting the conversation. This field typically requires a prior connection to your account to populate correctly.
4. **Message Body**\* - Enter the initial message for the conversation.

#### **Additional Settings to Create Ticket** <a href="#additional-settings-to-create-ticket" id="additional-settings-to-create-ticket"></a>

This action facilitates the creation of support tickets in Intercom, enabling efficient tracking and management of customer issues or requests.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Ticket Type**\* - Choose the type of ticket to create. This usually involves specifying whether it's a support, service, or other type of request.
3. **Contact ID**\* - Enter the ID of the customer or user for whom the ticket is being created. This field typically requires prior connection to your account to populate correctly.
4. **Company ID** - Specify the ID of the company associated with the ticket, if applicable.

&#x20;

#### **Additional Settings to Create User** <a href="#additional-settings-to-create-user" id="additional-settings-to-create-user"></a>

This action allows for the creation of new user profiles within Intercom, facilitating personalized communication and support.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Email**\* - Enter the email address of the user. This is a unique identifier for the user within Intercom.

**Optional Fields**

3. **Created At** - Specify the date and time when the user profile was created. Useful for backdating user entries.
4. **User ID** - If applicable, provide an existing user ID to link the new profile to other systems or databases.
5. **Full Name** - Enter the full name of the user for personalization and identification purposes.
6. **Custom Attributes** - Add any additional information or attributes relevant to the user profile using key-value pairs.

&#x20;

#### **Additional Settings to Create or Update Lead** <a href="#additional-settings-to-create-or-update-lead" id="additional-settings-to-create-or-update-lead"></a>

This action is used to create a new lead or update an existing one in Intercom, assisting in managing potential customer interactions effectively.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.

**Optional Fields**

2. **Lead ID** - Enter the identifier for the lead. If provided, the existing lead will be updated.
3. **Full Name** - Input the full name of the lead for proper identification and personalization.
4. **Email** - Specify the email address of the lead.
5. **Phone** - Enter the contact phone number of the lead.
6. **Unsubscribed From Emails** - Mark this option if the lead has opted out of email communications.
7. **Created At** - Define the creation date and time of the lead record. Useful for backdating entries.
8. **Custom Attributes** - Add any additional data points or attributes relevant to the lead using key-value pairs.

&#x20;

#### **Additional Settings to Create/Update User** <a href="#additional-settings-to-create-update-user" id="additional-settings-to-create-update-user"></a>

This action allows for creating a new user or updating an existing one within Intercom, facilitating the management and tracking of user interactions.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **Lookup Email**\* - The email address used to identify the user. If a user with this email exists, their record will be updated.

**Optional Fields**

3. **Full Name** - Enter the full name of the user for identification and communication purposes.
4. **User ID** - Specify an internal or unique identifier for the user.
5. **Phone** - Provide the user's phone number for additional contact methods.
6. **Created At** - Input the creation date and time for the user record. Useful for backdating user entries.
7. **Custom Attributes** - Add custom data fields for the user through key-value pairs, allowing for extended information storage that fits your operational needs.

#### **Additional Settings to Reply to Conversation** <a href="#additional-settings-to-reply-to-conversation" id="additional-settings-to-reply-to-conversation"></a>

This action facilitates direct communication within Intercom by enabling responses to existing conversations from the specified administrative account.

**Required Fields**

1. **Connection**\* - Select the connection to your Intercom account.
2. **From (Admin)**\* - Specifies the administrator account from which the reply will be sent. This field needs to be configured with your account first.
3. **Conversation ID**\* - The unique identifier for the conversation to which you are replying. Ensure this is linked to your account first.
4. **Message Body**\* - The text content of your reply to the conversation.

#### **Additional Settings to Send Message** <a href="#additional-settings-to-send-message" id="additional-settings-to-send-message"></a>

This action allows you to send messages directly from Intercom, utilizing pre-defined templates for consistent communication styles.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Message Type**\* - Choose the type of message to send (e.g., Email, SMS).
3. **Subject**\* - The subject line for the email message.
4. **Template**\* - Select a template to define the style and format of the email.
5. **From (Admin)**\* - The administrator's email from which the message will be sent. Account connection is required to populate this field.
6. **To**\* - The recipient's email address. This field must be linked to your account.
7. **Message Body**\* - The content of the message you wish to send.

**Optional Settings**

* **Create Conversation Without Contact Reply** - Option to create a conversation thread that does not require a reply from the contact.

&#x20;

#### **Additional Settings to Update Ticket** <a href="#additional-settings-to-update-ticket" id="additional-settings-to-update-ticket"></a>

This action enables updating the details of an existing support ticket in Intercom, allowing for real-time modifications based on customer interactions or internal updates.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Ticket Type**\* - Define the type of ticket to update (e.g., Support, Inquiry). Account connection is required to populate this field.
3. **Ticket**\* - Select the specific ticket to update. Account connection is required.
4. **Is Open** - Toggle to indicate whether the ticket is still open or closed.
5. **State** - Select the current state of the ticket from the options available.

**Optional Fields**

* **Snoozed Until** - Date and time until which the ticket is snoozed.
* **Assigned Admin** - Assign an administrator to the ticket. Account connection is required.

#### **Additional Settings to Find Company** <a href="#additional-settings-to-find-company" id="additional-settings-to-find-company"></a>

This action allows users to search for company information within Intercom based on specific criteria, facilitating targeted support and insights.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Search Field** - Specify the field to be used for searching. Options include company ID, name, email, etc. Account connection is required to populate this field.
3. **Search Value** - Enter the value to search for in the selected field.

#### **Additional Settings to Find Conversation** <a href="#additional-settings-to-find-conversation" id="additional-settings-to-find-conversation"></a>

This action enables users to search for conversations in Intercom based on specific criteria, allowing for efficient tracking and management of customer interactions.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Search Field** - Choose the field to be used for the search, such as conversation ID, user ID, or email. Account connection is required to populate this field.
3. **Match Type** - Specify the type of match required for the search, such as exact match or partial match.
4. **Search Term** - Enter the term to search for in the selected field.

**Optional Fields**

1. **Status** - Filter the search by the status of the conversation (open, closed, etc.).
2. **Update After** - Limit search results to conversations updated after this date.
3. **Update Before** - Limit search results to conversations updated before this date.

#### **Additional Settings to Find Lead** <a href="#additional-settings-to-find-lead" id="additional-settings-to-find-lead"></a>

This action facilitates searching for leads in Intercom using specific search criteria, enabling efficient tracking and management of potential customer interactions.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Search Field** - Determine the field to search within, such as lead ID, email, or name. A connection to your account is required to populate this field.
3. **Search Value** - Input the value to look for in the specified search field.

&#x20;

#### **Additional Settings to Find User** <a href="#additional-settings-to-find-user" id="additional-settings-to-find-user"></a>

This action allows you to search for users within Intercom based on specific criteria, streamlining the process of user management and engagement.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Search Field** - Choose the user attribute you want to search by, such as user ID, email, or name. A connection to your account is necessary to populate this field.
3. **Search Value** - Enter the value to search for within the chosen search field.

#### **Additional Settings to List Tags** <a href="#additional-settings-to-list-tags" id="additional-settings-to-list-tags"></a>

This feature allows you to retrieve a list of all tags created in Intercom, helping to manage and organize user segments more effectively.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account to access the tags.

&#x20;

#### **Additional Settings to Retrieve a Conversation** <a href="#additional-settings-to-retrieve-a-conversation" id="additional-settings-to-retrieve-a-conversation"></a>

This component allows you to retrieve details about a specific conversation in Intercom. It is essential for reviewing past interactions and managing ongoing conversations efficiently.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account to access the conversations.
2. **Conversation ID** - Enter the unique identifier for the conversation you wish to retrieve.

&#x20;

#### **Additional Settings to Custom API Call** <a href="#additional-settings-to-custom-api-call" id="additional-settings-to-custom-api-call"></a>

This function allows you to make custom API calls to Intercom, offering flexibility to perform specific actions or retrieve data that standard integrations do not cover.

**Required Fields**

1. **Connection** - Select the connection to your Intercom account.
2. **Method** - Choose the HTTP method for the API call (e.g., GET, POST, PUT, DELETE).
3. **Headers** - Add custom headers for the API request. Authorization headers are injected automatically based on your connection.
4. **Query Parameters** - Specify any query parameters required for the API call.
5. **Body** - Enter the request body for methods that require it, such as POST or PUT.

**Optional Settings**

* **No Error on Failure** - Check this if you do not want the API call to be considered a failure in case of non-200 status responses.
* **Timeout (in seconds)** - Set a timeout for the API call. Useful for ensuring that long-running requests do not hinder workflow execution.
