Connectors Reference
Intercom makes messaging apps for businesses that help them understand and talk to consumers.
|
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
|
Name |
Summary |
|
List users |
|
|
Create or update user |
|
|
List all leads |
|
|
Create new lead |
|
|
List companies |
|
|
Get user |
|
|
Get lead |
|
Name |
Summary |
|
When a lead is created |
|
|
When a user is created |
|
|
When a user is updated |
|
|
When a new conversation starts |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List users
Description: List all users.
Syntax:
Intercom.ListUsers ()
Returns:
Type:array of (User_Response)
Summary: Create or update user
Description: Creates a new user for your Intercom account. Users found via email will be updated.
Syntax:
Intercom.CreateUser (CreateUserParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:User_Response
Summary: List all leads
Description: Returns a list of all leads within your Intercom account.
Syntax:
Intercom.ListLeads ()
Returns:
Type:array of (Lead_Response)
Summary: Create new lead
Description: Creates a new lead for your Intercom account.
Syntax:
Intercom.CreateLead (CreateLeadParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:Lead_Response
Summary: List companies
Description: List all companies.
Syntax:
Intercom.ListCompanies ()
Returns:
Summary: Get user
Description: Given the id for an existing user, this operation returns all information about the user.
Syntax:
Intercom.GetUser (string user_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
user_id |
string (User Id) |
The id of the user |
True |
Returns:
Type:User_Response
Summary: Get lead
Description: Given the id for an existing lead, this operation returns all information about the lead.
Syntax:
Intercom.GetLead (string contact_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
contact_id |
string (Lead Id) |
The id of the lead |
True |
Returns:
Type:Lead_Response
Summary: When a lead is created
Description: Triggers when a new lead is created.
Syntax:
Intercom.TrigNewLead ()
Returns:
Type:array of (TrigLead_Response)
Summary: When a user is created
Description: Triggers when a new user is created.
Syntax:
Intercom.TrigNewUser ()
Returns:
Type:array of (TrigUser_Response)
Summary: When a user is updated
Description: Triggers when an existing user's information is updated.
Syntax:
Intercom.TrigUpdateUser ()
Returns:
Type:array of (TrigUser_Response)
Summary: When a new conversation starts
Description: Triggers when a user starts a new conversation.
Syntax:
Intercom.TrigNewConversation ()
Returns:
Type:array of (TrigConversation_Response)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
|
|
name |
string Name |
|
|
phone |
string Phone |
|
|
avatar |
Avatar |
|
|
companies |
string Company Id |
|
Summary: Avatar
Description:
Properties:
|
Name |
Type |
Summary |
|
image_url |
string Image URL |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string |
|
|
name |
string Name |
|
|
phone |
string Phone |
|
|
companies |
string Company Id |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Intercom defined id representing the lead. |
|
created_at |
string Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
user_id |
string Lead Id |
Unique identifier you have defined for the lead. |
|
|
string |
Lead's email. |
|
phone |
string Phone |
Lead's phone number. |
|
name |
string Name |
Lead's name. |
|
avatar |
|
|
|
unsubscribed_from_emails |
boolean Is Unsubscribed |
An avatar image URL, needs to be https. |
|
location_data |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
image_url |
string Image URL |
An avatar image URL, needs to be https. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city_name |
string City Name |
Location of the lead. |
|
country_name |
string Country Name |
Location of the lead. |
|
latitude |
number Latitude |
Location of the lead. |
|
longitude |
number Longitude |
Location of the lead. |
|
postal_code |
string Postal Code |
Location of the lead. |
|
region_name |
string Region Name |
Location of the lead. |
|
timezone |
string Time Zone |
ISO 8601 time zone for the lead's location. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem) companies |
companies |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
company_id |
string company_id |
company_id |
|
id |
string id |
id |
|
name |
string name |
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
assignee |
|
assignee |
|
conversation_message |
|
conversation_message |
|
created_at |
string Created Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
id |
string Id |
Conversation id. |
|
updated_at |
string Updated Date Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
user |
|
user |
Summary:
Description: assignee
Properties:
|
Name |
Type |
Summary |
|
id |
string Admin Id |
User the conversation is currently assigned to. |
Summary:
Description: conversation_message
Properties:
|
Name |
Type |
Summary |
|
author |
|
|
|
body |
string Text |
Body of the message. |
|
subject |
string Subject |
Conversation subject. |
|
url |
string Message URL |
URL of the conversation message. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Author Id |
Conversation author's id. |
|
type |
string Author Type |
Type of the author. |
Summary:
Description: user
Properties:
|
Name |
Type |
Summary |
|
id |
string User Id |
Id of user the conversation concerns. |
|
type |
string User Type |
The user type. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Intercom defined id representing the lead. |
|
created_at |
string Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
user_id |
string User Id |
Unique identifier you have defined for the user. |
|
|
string |
Lead's email. |
|
phone |
string Phone |
Lead's phone number. |
|
name |
string Name |
Lead's name. |
|
avatar |
|
|
|
unsubscribed_from_emails |
boolean Is Unsubscribed |
True if the lead is unsubscribed from emails. |
|
location_data |
|
|
|
companies |
|
|
|
tags |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
image_url |
string Image URL |
An avatar image URL, needs to be https. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city_name |
string City Name |
Location of the lead. |
|
country_name |
string Country Name |
Location of the lead. |
|
latitude |
number Latitude |
Location of the lead. |
|
longitude |
number Longitude |
Location of the lead. |
|
postal_code |
string Postal Code |
Location of the lead. |
|
region_name |
string Region Name |
Location of the lead. |
|
timezone |
string Time Zone |
ISO 8601 time zone for the lead's location. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem)
|
companies |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Company Name |
Name of the company. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem)
|
tags |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Tag Name |
Name of the tag. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Intercom defined id representing the user. |
|
created_at |
string Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
user_id |
string User Id |
Unique identifier you have defined for the user. |
|
|
string |
User's email. |
|
phone |
string Phone |
User's phone number. |
|
name |
string Name |
User's name. |
|
session_count |
integer Session Count |
Number of sessions the user has recorded. |
|
avatar |
|
|
|
unsubscribed_from_emails |
boolean Is Unsubscribed |
True if the user is unsubscribed from emails. |
|
location_data |
|
|
|
pseudonym |
string Pseudonym |
The pseudonym used if this user was previously a lead. |
|
companies |
|
|
|
tags |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
image_url |
string Image URL |
An avatar image URL, needs to be https. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city_name |
string City Name |
Location of the user. |
|
country_name |
string Country Name |
Location of the user. |
|
latitude |
number Latitude |
Location of the user. |
|
longitude |
number Longitude |
Location of the user. |
|
postal_code |
string Postal Code |
Location of the user. |
|
region_name |
string Region Name |
Location of the user. |
|
timezone |
string Time Zone |
ISO 8601 time zone for the user's location. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem)
|
companies |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Company Name. |
Name of the company. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
companies |
array of (CompaniesItem)
|
tags |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string Tag Name |
Name of the tag. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string Id |
Intercom defined id representing the user. |
|
created_at |
string Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
user_id |
string User Id |
Unique identifier you have defined for the user. |
|
|
string |
User's email. |
|
phone |
string Phone |
User's phone number. |
|
name |
string Name |
User's name. |
|
session_count |
integer Session Count |
Number of sessions the user has recorded. |
|
avatar |
|
|
|
unsubscribed_from_emails |
boolean Is Unsubscribed |
An avatar image URL, needs to be https. |
|
location_data |
|
|
|
pseudonym |
string Pseudonym |
The pseudonym used if this user was previously a lead. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
image_url |
string Image URL |
An avatar image URL, needs to be https. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
city_name |
string City Name |
Location of the user. |
|
country_name |
string Country Name |
Location of the user. |
|
latitude |
number Latitude |
Location of the user. |
|
longitude |
number Longitude |
Location of the user. |
|
postal_code |
string Postal Code |
Location of the user. |
|
region_name |
string Region Name |
Location of the user. |
|
timezone |
string Time Zone |
ISO 8601 time zone for the user's location. |