Intercom Integration

Field	Description	Required	Format
Access Token	Your Intercom Access Token	Yes	`dG9rOjxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
API Base URL	Intercom API base URL (optional — leave empty for https://api.intercom.io US default). Set to https://api.eu.intercom.io for EU workspaces or https://api.au.intercom.io for Australia.	No	`https://api.intercom.io`

get_contact — Get a contact by their unique Intercom ID

Parameters

string

required

The unique identifier for the contact

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetContactOutput",
  "type": "object"
}

search_contacts — Search for contacts using various fields and operators

Parameters

string

Field to search by (email, name, phone, role, external_id, etc.) (Default: email)

string

Query operator (=, !=, >, <, ~~, !~~, IN, NIN) (Default: =)

string

required

Value to search for

integer

Results per page (max 150) (Default: 50)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "contacts": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Contacts",
      "type": "array"
    },
    "total_count": {
      "default": 0,
      "title": "Total Count",
      "type": "integer"
    },
    "pages": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pages"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchContactsOutput",
  "type": "object"
}

upsert_contact — Create a new contact or update an existing one by email. Searches first; on match it PUTs, otherwise it POSTs.

Parameters

string

required

The contact’s email address

string

Role of the contact (‘user’ or ‘lead’)

string

A unique identifier from your system

string

The contact’s phone number

string

The contact’s name

string

URL of the avatar image

boolean

Whether the contact is unsubscribed from emails

object

Custom attributes for the contact

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "action_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Action Type"
    },
    "contact": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Contact"
    }
  },
  "required": [
    "success"
  ],
  "title": "UpsertContactOutput",
  "type": "object"
}

create_note — Create a note on a contact's record. Auto-attributes the note to the authenticated admin (via a side GET to /me).

Parameters

string

required

The contact’s unique Intercom identifier

string

required

The note content (supports HTML)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateNoteOutput",
  "type": "object"
}

add_tag_to_contact — Add a tag to a contact

Parameters

string

required

The contact’s unique Intercom identifier

string

required

The tag’s unique identifier

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddTagToContactOutput",
  "type": "object"
}

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListTagsOutput",
  "type": "object"
}

list_admins — List all admins/teammates in the Intercom workspace

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListAdminsOutput",
  "type": "object"
}

get_conversation — Get a conversation by its unique ID

Parameters

string

required

The conversation’s unique identifier

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetConversationOutput",
  "type": "object"
}

list_conversations — List conversations in the Intercom workspace

Parameters

integer

Conversations per page (max 150) (Default: 20)

string

Pagination cursor from previous response

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "conversations": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Conversations",
      "type": "array"
    },
    "pages": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pages"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListConversationsOutput",
  "type": "object"
}

search_conversations — Search for conversations using various fields and operators

Parameters

string

Field to search by (created_at, state, source.type, etc.) (Default: created_at)

string

Query operator (=, !=, >, <, IN, NIN) (Default: >)

string

required

Value to search for (timestamp for date fields)

integer

Results per page (max 150) (Default: 20)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "conversations": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Conversations",
      "type": "array"
    },
    "total_count": {
      "default": 0,
      "title": "Total Count",
      "type": "integer"
    },
    "pages": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pages"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchConversationsOutput",
  "type": "object"
}

send_incoming_message — Send a message from a user to start a conversation. Auto-detects the contact's role via a side GET.

Parameters

string

required

The contact’s unique Intercom identifier

string

required

The message content

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendIncomingMessageOutput",
  "type": "object"
}

send_message_to_contact — Send a message from an admin to a contact

Parameters

string

required

The admin’s unique identifier

string

required

The contact’s unique identifier

string

Recipient type (‘user’ or ‘lead’) (Default: user)

string

Message type (‘in_app’ or ‘email’) (Default: in_app)

string

required

Subject/title of the message

string

required

Message content (HTML and plaintext supported)

string

Template style (‘plain’ or ‘personal’) (Default: personal)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendMessageToContactOutput",
  "type": "object"
}

reply_to_conversation — Reply to an existing conversation

Parameters

string

required

The conversation’s unique identifier

string

required

Type of reply (‘user’ or ‘admin’)

string

Message type (‘comment’ or ‘note’, note only for admin) (Default: comment)

string

required

The reply content

string

Admin ID (required if reply_type is ‘admin’)

string

Intercom user ID (for user reply)

array

List of image URLs to attach (max 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "result": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Result"
    }
  },
  "required": [
    "success"
  ],
  "title": "ReplyToConversationOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Intercom Integration for AI Agents & Workflows

Overview

Authentication

Access Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Klaviyo

Pinterest

ServiceNow

Links

​Overview

​Authentication

​Access Token

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Klaviyo

Pinterest

ServiceNow

​Links

Overview

Authentication

Access Token

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links