Intercom: Create Conversation

Start an Intercom conversation with a message from a contact.

Tool ID: intercom_create_conversation

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe intercom_create_conversation --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "example",
    "id": "id_123",
    "created_at": 123,
    "body": "Example message",
    "message_type": "email"
  }
}

Use deepline describe intercom_create_conversation --json for the latest machine-readable contract.

Input reference

Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.

Name	Type	Required	Default	Details
`payload.from`	`object`	Yes	—	—
`payload.body`	`string`	Yes	—	The content of the message. HTML is not supported.
`payload.subject`	`string`	No	—	The title of the email. Only applicable if the message type is email.
`payload.attachment_urls`	`array`	No	—	A list of image URLs that will be added as attachments. You can include up to 10 URLs. Maximum items: 10.
`payload.created_at`	`integer`	No	—	The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom. Format: `date-time`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Message are how you contact contacts in Intercom. They are created when an admin sends an outbound message to a contact.
`result.data.type`	`string`	Yes	—	The type of the message
`result.data.id`	`string`	Yes	—	The id representing the message.
`result.data.created_at`	`integer`	Yes	—	The time the conversation was created. Format: `date-time`.
`result.data.subject`	`string`	No	—	The subject of the message. Only present if message_type: email.
`result.data.body`	`string`	Yes	—	The message body, which may contain HTML.
`result.data.message_type`	`"email" \| "inapp" \| "facebook" \| "twitter"`	Yes	—	The type of message that was sent. Can be email, inapp, facebook or twitter. Allowed: `email`, `inapp`, `facebook`, `twitter`.
`result.data.conversation_id`	`string`	No	—	The associated conversation_id
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation