Connectors Reference

Intercom

Intercom makes messaging apps for businesses that help them understand and talk to consumers.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListUsers ()

List users

CreateUser (CreateUserParameterBody body)

Create or update user

ListLeads ()

List all leads

CreateLead (CreateLeadParameterBody body)

Create new lead

ListCompanies ()

List companies

GetUser (string user_id)

Get user

GetLead (string contact_id)

Get lead

 

Triggers:

Name

Summary

TrigNewLead ()

When a lead is created

TrigNewUser ()

When a user is created

TrigUpdateUser ()

When a user is updated

TrigNewConversation ()

When a new conversation starts

 

Objects:

Name

Summary

CreateLeadParameterBody

 

CreateUserParameterBody

 

Lead_Response

 

ListCompanies_Response

 

TrigConversation_Response

 

TrigLead_Response

 

TrigUser_Response

 

User_Response

 

 

Actions:

ListUsers

Summary: List users

Description: List all users.

 

Syntax:

Intercom.ListUsers ()

 

Returns:

          Type:array of (User_Response)

 

CreateUser

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

CreateUserParameterBody

 

 

True

 

Returns:

          Type:User_Response

 

ListLeads

Summary: List all leads

Description: Returns a list of all leads within your Intercom account.

 

Syntax:

Intercom.ListLeads ()

 

Returns:

          Type:array of (Lead_Response)

 

CreateLead

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

CreateLeadParameterBody

 

 

True

 

Returns:

          Type:Lead_Response

 

ListCompanies

Summary: List companies

Description: List all companies.

 

Syntax:

Intercom.ListCompanies ()

 

Returns:

          Type:ListCompanies_Response

 

GetUser

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

 

GetLead

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

 

Triggers:

Trigger TrigNewLead

Summary: When a lead is created

Description: Triggers when a new lead is created.

 

Syntax:

Intercom.TrigNewLead ()

 

Returns:

          Type:array of (TrigLead_Response)

 

Trigger TrigNewUser

Summary: When a user is created

Description: Triggers when a new user is created.

 

Syntax:

Intercom.TrigNewUser ()

 

Returns:

          Type:array of (TrigUser_Response)

 

Trigger TrigUpdateUser

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)

 

Trigger TrigNewConversation

Summary: When a new conversation starts

Description: Triggers when a user starts a new conversation.

 

Syntax:

Intercom.TrigNewConversation ()

 

Returns:

          Type:array of (TrigConversation_Response)

 


 

CreateLeadParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Email

 

name

string

Name

 

phone

string

Phone

 

avatar

Avatar

Avatar

 

companies

string

Company Id

 

 

Avatar

Summary: Avatar

Description:

 

          Properties:

Name

Type

Summary

image_url

string

Image URL

 

 


 

CreateUserParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Email

 

name

string

Name

 

phone

string

Phone

 

companies

string

Company Id

 


 

Lead_Response

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.

email

string

Email

Lead's email.

phone

string

Phone

Lead's phone number.

name

string

Name

Lead's name.

avatar

Avatar

 

 

unsubscribed_from_emails

boolean

Is Unsubscribed

An avatar image URL, needs to be https.

location_data

Location_data

 

 

 

Avatar

Summary:

Description:

 

          Properties:

Name

Type

Summary

image_url

string

Image URL

An avatar image URL, needs to be https.

 

Location_data

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.

 


 

ListCompanies_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

companies

array of (CompaniesItem)

companies

companies

 

CompaniesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

company_id

string

company_id

company_id

id

string

id

id

name

string

name

name

 


 

TrigConversation_Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

assignee

Assignee

 

assignee

conversation_message

Conversation_message

 

conversation_message

created_at

string

Created Date Time

yyyy-MM-ddTHH:mm:ss.fffZ

id

string

Id

Conversation id.

updated_at

integer(int32)

Updated Date Time

yyyy-MM-ddTHH:mm:ss.fffZ

user

User

 

user

 

Assignee

Summary:

Description: assignee

 

          Properties:

Name

Type

Summary

id

string

Admin Id

User the conversation is currently assigned to.

 

Conversation_message

Summary:

Description: conversation_message

 

          Properties:

Name

Type

Summary

author

Author

 

 

body

string

Text

Body of the message.

subject

string

Subject

Conversation subject.

url

string

Message URL

URL of the conversation message.

 

Author

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Author Id

Conversation author's id.

type

string

Author Type

Type of the author.

 

User

Summary:

Description: user

 

          Properties:

Name

Type

Summary

id

string

User Id

Id of user the conversation concerns.

type

string

User Type

The user type.

 


 

TrigLead_Response

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.

email

string

Email

Lead's email.

phone

string

Phone

Lead's phone number.

name

string

Name

Lead's name.

avatar

Avatar

 

 

unsubscribed_from_emails

boolean

Is Unsubscribed

True if the lead is unsubscribed from emails.

location_data

Location_data

 

 

companies

Companies

 

 

tags

Tags

 

 

 

Avatar

Summary:

Description:

 

          Properties:

Name

Type

Summary

image_url

string

Image URL

An avatar image URL, needs to be https.

 

Location_data

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.

 

Companies

Summary:

Description:

 

          Properties:

Name

Type

Summary

companies

array of (CompaniesItem)

 

companies

 

CompaniesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Company Name

Name of the company.

 

Tags

Summary:

Description:

 

          Properties:

Name

Type

Summary

companies

array of (CompaniesItem)

 

tags

 

CompaniesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Tag Name

Name of the tag.

 


 

TrigUser_Response

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.

email

string

Email

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

Avatar

 

 

unsubscribed_from_emails

boolean

Is Unsubscribed

True if the user is unsubscribed from emails.

location_data

Location_data

 

 

pseudonym

string

Pseudonym

The pseudonym used if this user was previously a lead.

companies

Companies

 

 

tags

Tags

 

 

 

Avatar

Summary:

Description:

 

          Properties:

Name

Type

Summary

image_url

string

Image URL

An avatar image URL, needs to be https.

 

Location_data

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.

 

Companies

Summary:

Description:

 

          Properties:

Name

Type

Summary

companies

array of (CompaniesItem)

 

companies

 

CompaniesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Company Name.

Name of the company.

 

Tags

Summary:

Description:

 

          Properties:

Name

Type

Summary

companies

array of (CompaniesItem)

 

tags

 

CompaniesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Tag Name

Name of the tag.

 


 

User_Response

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.

email

string

Email

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

Avatar

 

 

unsubscribed_from_emails

boolean

Is Unsubscribed

An avatar image URL, needs to be https.

location_data

Location_data

 

 

pseudonym

string

Pseudonym

The pseudonym used if this user was previously a lead.

 

Avatar

Summary:

Description:

 

          Properties:

Name

Type

Summary

image_url

string

Image URL

An avatar image URL, needs to be https.

 

Location_data

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.