Create Widget Integration

Create Widget integration

post
/v1/integration/widget/create

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

namestring

The associated name

descriptionstring

The associated description

metaobject

Meta data information

themestring

The theme of the Widget integration

layoutstring

The default layout of the Widget integration

titlestring

The title of the Widget integration

introstring

The intro of the Widget integration

initialstring

The initial message of the Widget integration

placeholderstring

The input placeholder of the Widget integration

originstring

The origin URLs of the Widget integration

sessionDurationnumber

The session duration of the Widget integration

languagestring

The language of the Widget integration

streamboolean

Whether the Widget integration is streaming

verboseboolean

Whether the Widget integration is verbose

toolsboolean

Whether the Widget integration has tools

unfurlboolean

Whether the Widget integration unfurls links

autoScrollboolean

Whether the Widget integration auto scrolls

startFirstboolean

Whether the Widget integration starts first

contactCollectionboolean

Whether the Widget integration collects contacts

exportConversationboolean

Controls whether the Widget allows exporting the current conversation

maximizeboolean

Controls whether the Widget allows maximizing the conversation

messagePeekboolean

Controls whether the Widget allows peeking at the initial messages

restartConversationboolean

Controls whether the Widget allows restarting the conversation

poweredByboolean

Whether the Widget integration displays powered by ChatBotKit

botIdstring

The ID of the bot this configuration is using

curl -X POST "https://api.chatbotkit.com/v1/integration/widget/create" \

-H "Authorization: Bearer $CHATBOTKIT_API_SECRET" \

-H "Content-Type: application/json" \

--data-binary @- << EOF
{
"name":"string",
"description":"string",
"meta":"object",
"theme":"string",
"layout":"string",
"title":"string",
"intro":"string",
"initial":"string",
"placeholder":"string",
"origin":"string",
"sessionDuration":"number",
"language":"string",
"stream":"boolean",
"verbose":"boolean",
"tools":"boolean",
"unfurl":"boolean",
"autoScroll":"boolean",
"startFirst":"boolean",
"contactCollection":"boolean",
"exportConversation":"boolean",
"maximize":"boolean",
"messagePeek":"boolean",
"restartConversation":"boolean",
"poweredBy":"boolean",
"botId":"string"
}
EOF
{
"id":"string"
}
The Widget integration was created successfully