Intercom: Start Fin Conversation

Start an Intercom Fin conversation with a user message, history and user details.

Tool ID: intercom_start_fin_conversation

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_start_fin_conversation',
  {
    "conversation_id": "conversation_123",
    "message": {
      "author": "user",
      "body": "Example message",
      "timestamp": "2026-01-15T12:00:00Z"
    },
    "user": {
      "id": "id_123"
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_start_fin_conversation --input '{
  "conversation_id": "conversation_123",
  "message": {
    "author": "user",
    "body": "Example message",
    "timestamp": "2026-01-15T12:00:00Z"
  },
  "user": {
    "id": "id_123"
  }
}' --json

Example response

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

{
  "data": {
    "conversation_id": "conversation_123",
    "user_id": "user_123",
    "status": "thinking"
  }
}

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

Input reference

Initialize Fin by passing it the user’s message along with conversation history and user details. These additional pieces of context will be used by Fin to provide a better and more contextual answer to the user. Please contact your accounts team to discuss access. Once Fin is initialized, it progresses through a series of statuses such as thinking, awaiting_user_reply, or resolved before ending with a status of complete. During this workflow, the client should allow Fin to continue uninterrupted until a final complete status is returned via webhook, at which point control of the conversation passes back to the client.

Name	Type	Required	Default	Details
`payload.conversation_id`	`string`	Yes	—	The ID of the conversation that is calling Fin via this API.
`payload.message`	`object`	Yes	—	A message exchanged within a Fin Agent conversation.
`payload.user`	`object`	Yes	—	A user object representing the user in a Fin Agent conversation.
`payload.attachments`	`array`	No	—	An array of attachments to include with the message. Maximum of 10 attachments. Maximum items: 10.
`payload.conversation_metadata`	`object`	No	—	Metadata about the conversation, including history and attributes.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.conversation_id`	`string`	No	—	The ID of the conversation.
`result.data.user_id`	`string`	No	—	The ID of the user.
`result.data.status`	`"thinking" \| "awaiting_user_reply" \| "escalated" \| "resolved" \| "complete"`	No	—	Fin’s current status in the conversation workflow. Allowed: `thinking`, `awaiting_user_reply`, `escalated`, `resolved`, `complete`.
`result.data.created_at_ms`	`string`	No	—	The timestamp the response was created at, with millisecond precision. Format: `date-time`.
`result.data.errors`	`object`	No	—	Contains error details if any user or conversation attribute updates failed.
`result.data.errors.user`	`object`	No	—	User-related attribute errors.
`result.data.errors.user.attributes`	`record`	No	—	Map of user attribute names to error messages.
`result.data.errors.conversation`	`object`	No	—	Conversation-related attribute errors.
`result.data.errors.conversation.attributes`	`record`	No	—	Map of conversation attribute names to error messages.
`result.data.sse_subscription_url`	`string`	No	—	Optional. A URL to subscribe to Server-Sent Events (SSE) for this conversation, if SSE is enabled. The access token is a JWT with a 3-minute TTL. The token is revoked when Fin sets the conversation to awaiting_user_reply or complete status.
`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

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation