provider Fin Agent POST /fin/start
@utdk/intercom /fin/start
Start a conversation with Fin
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. {% admonition type="warning" %} Please reach out to your accounts team to discuss access. {% /admonition %} 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.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

startfinconversation
POST/fin/start
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. {% admonition type="warning" %} Please reach out to your accounts team to discuss access. {% /admonition %} 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.

Input

required

The ID of the conversation that is calling Fin via this API.

required

A message exchanged within a Fin Agent conversation.

required

A user object representing the user in a Fin Agent conversation.

An array of attachments to include with the message. Maximum of 10 attachments.

Metadata about the conversation, including history and attributes.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.startfinconversation({
  "Intercom-Version": "2.14"
})