For the complete documentation index, see llms.txt. This page is also available as Markdown.

Widgets

Lists the messages of a conversation for the widget

get
Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The Id of the chatbot.

conversationIdstringRequired

The Id of the conversation.

Query parameters
tokenstringRequired

The widget token.

Responses
200Success
application/json
errorstringOptional

Optional error message.

get
/v1/widget/{chatbotId}/conversations/{conversationId}/messages
200Success

Creates a new conversation via the widget

post
Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The Id of the chatbot.

Body
widgetTokenstringRequired

The widget authentication token.

Example: widget_token_abc123xyz
channelIdstringRequired

The ID of the channel.

Example: channel_abc123
languagestringRequired

The language code for the conversation.

Example: DE
Responses
post
/v1/widget/{chatbotId}/conversations

Creates a new contact via the widget

post
Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The Id of the chatbot.

Body
channelIdstringRequired

The ID of the channel.

Example: channel_abc123
channelTokenstringRequired

The channel authentication token.

Example: channel_token_xyz789
originUrlstringRequired

The origin URL where the widget is embedded.

Example: https://example.com/contact
languagestringRequired

The language code for the widget.

Example: DE
Responses
post
/v1/widget/{chatbotId}/contact

Last updated