Intercom

Intercom is the complete AI-first customer service solution, giving exceptional experiences for support teams with AI agent, AI copilot, tickets, …

Categories: Customer Support

Type: intercom/v1

---

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client id	STRING		true
clientSecret	Client secret	STRING		true

---

Actions

Create Contact

Name: createContact

Create new contact

Properties

Name	Label	Type	Description	Required
role	Contact Role	STRING Options user, lead	Role of the contact	true
email	Contact Email	STRING	Email of the contact	true
name	Contact Name	STRING	Name of the contact	false
phone	Contact Phone	STRING	Phone of the contact must start with a ”+” sign	false
avatar	Contact Image	STRING	Image of the contact	false

Example JSON Structure

{
  "label" : "Create Contact",
  "name" : "createContact",
  "parameters" : {
    "role" : "",
    "email" : "",
    "name" : "",
    "phone" : "",
    "avatar" : ""
  },
  "type" : "intercom/v1/createContact"
}

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	The type of the contact.
id	STRING	ID of the contact.
role	STRING	Role of the contact.
email	STRING	Email of the contact.
phone	STRING	The contacts phone.
name	STRING	The contacts name.

Output Example

{
  "type" : "",
  "id" : "",
  "role" : "",
  "email" : "",
  "phone" : "",
  "name" : ""
}

Get Contact

Name: getContact

Get a single Contact

Properties

Name	Label	Type	Description	Required
id	Contact ID	STRING		true

Example JSON Structure

{
  "label" : "Get Contact",
  "name" : "getContact",
  "parameters" : {
    "id" : ""
  },
  "type" : "intercom/v1/getContact"
}

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	The type of the contact.
id	STRING	ID of the contact.
role	STRING	Role of the contact.
email	STRING	Email of the contact.
phone	STRING	The contacts phone.
name	STRING	The contacts name.

Output Example

{
  "type" : "",
  "id" : "",
  "role" : "",
  "email" : "",
  "phone" : "",
  "name" : ""
}

Send Message

Name: sendMessage

Send a new message

Properties

Name	Label	Type	Description	Required
message_type	Message Type	STRING Options inapp, email	In app message or email message	true
subject	Title	STRING	Title of the Email/Message	true
body	Content	STRING	Content of the message	true
template	Template	STRING Options plain, personal	The style of the outgoing message	true
to	To	STRING	ID of the contact to send the message to.	true

Example JSON Structure

{
  "label" : "Send Message",
  "name" : "sendMessage",
  "parameters" : {
    "message_type" : "",
    "subject" : "",
    "body" : "",
    "template" : "",
    "to" : ""
  },
  "type" : "intercom/v1/sendMessage"
}

Output

Type: OBJECT

Properties

Name	Type	Description
type	STRING	The type of the message.
id	STRING	ID of the message.
subject	STRING	The subject of the message.
body	STRING	The message body, which may contain HTML.
message_type	STRING	The type of message that was sent.
conversation_id	STRING	The associated conversation_id.

Output Example

{
  "type" : "",
  "id" : "",
  "subject" : "",
  "body" : "",
  "message_type" : "",
  "conversation_id" : ""
}