Conversations

Initiate Chat

Lets the agent of a Chat integration start a message to a group or handle

post

/v1/integration/chat/{chatIntegrationId}/initiate

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

chatIntegrationIdstring* Required

The ID of the Chat integration whose agent writes

Request Body * Required

Request Body Schema: application/json

tostring

The destination, a

textstring

The text instruction the agent writes its message from


import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({
token: process.env.CHATBOTKIT_API_TOKEN!
})

const response = await cbk.integration.chat.initiate(
chatIntegrationId, 
{"to":"string",
"text":"string"
}
)

{"id":"string"
}

The Chat integration was successfully initiated

Go to cbk.ai