Widget Integrations
Fetch Widget Integration
Fetch a widgetIntegration
get
/v1/integration/widget/{widgetIntegrationId}/fetch
Authorization
ChatBotKit API Secret * Required
HTTP Authorization Scheme: bearer
Path Parameters
widgetIntegrationIdstring* Required
The ID of the Widget integration to retrieve
import { ChatBotKit } from '@chatbotkit/sdk'
const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})
const response = await cbk.integration.widget.fetch(
widgetIntegrationId)
{"name":"string","description":"string","meta":"object","id":"string","createdAt":"number","updatedAt":"number","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","math":"boolean","carousel":"boolean","from":"boolean","attachments":"boolean","autoScroll":"boolean","startFirst":"boolean","contactCollection":"boolean","exportConversation":"boolean","restartConversation":"boolean","maximize":"boolean","messagePeek":"boolean","voiceIn":"boolean","voiceOut":"boolean","poweredBy":"boolean","botId":"string"}The Widget integration was retrieved successfully