Widget Integration

Fetch a widgetIntegration

get/integration/widget/{widgetIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/widget/{widgetIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

widgetIntegrationIdstring required

The ID of the Widget integration to retrieve

Response

The Widget integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

botIdstring nullable

The ID of the bot this configuration is using

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

pluginsstring

The plugins 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

mathboolean

Whether the Widget integration supports math

carouselboolean

Whether the Widget integration supports carousels

formboolean

Whether the Widget integration supports forms

attachmentsboolean

Whether the Widget integration supports attachments

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

restartConversationboolean

Controls whether the Widget allows restarting the conversation

maximizeboolean

Controls whether the Widget allows maximizing the conversation

messagePeekboolean

Controls whether the Widget allows peeking at the initial messages

voiceInboolean

Whether the Widget integration supports voice input

voiceOutboolean

Whether the Widget integration supports voice output

poweredByboolean

Whether the Widget integration displays powered by

Changes

No recorded changes to this operation across all 1 revision of this API.