Voiceflow bearer token
Widgets
Configure your agent’s chat widget.
Paste in your agent
1. Set up Voiceflow by following https://www.voiceflow.com/agents/setup 2. Read https://www.voiceflow.com/docs/api-reference/resources/widget.md — the Voiceflow documentation page "Widgets". Use it to help me with this part of Voiceflow and answer my questions. Refer to https://www.voiceflow.com/docs/llms.txt if you need related documentation.
See Authentication for credentials and permissions.
/v1/stable/widgetReturns the widget configuration stored on the environment's draft version: which surface the embed runs and the settings of each surface. Visitors see the published version, so this can differ from the live site until the environment is published.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf widget get --project-id <projectID> --environment-alias <environmentAlias>{
"widget": {
"type": "<WidgetSettingsWidgetType>",
"chat": "<WidgetSettingsChatSettings>",
"voice": "<WidgetSettingsVoiceSettings>",
"common": "<WidgetSettingsCommonSettings>",
"security": "<WidgetSettingsSecuritySettings>"
}
}Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
200 - application/jsonReturns the widget with its surface type and its chat, voice, common, and security blocks, as stored on the environment's draft version.
The widget configuration stored on the environment's draft version.
Show child attributes
Which surface the embed runs: chat for a text chat widget, voice for a click-to-call widget. It selects whether the chat or the voice block is applied at runtime; the other is kept but ignored.
chat, voiceThe chat surface, applied when type is chat: how it renders on the page (floating widget, inline embed, or popover), its header and agent images, the opening banner, the input placeholder, the privacy and AI disclaimers, voice input and output, file upload, and the end-of-conversation CSAT survey.
Show child attributes
embed, widget, popoverShow child attributes
Show child attributes
Show child attributes
Show child attributes
The voice surface, applied when type is voice: how the call screen renders, and the copy shown through a call — the call-to-action, the start and end button labels, and the listening and talking states.
Show child attributes
full, compact, expandChrome shared by both surfaces: the launcher, the primary color and its palette, the font, the position and spacing on the page, the width, the Voiceflow footer link, and where the conversation is persisted between page loads.
Show child attributes
right, leftmemory, localStorage, sessionStorageApproved-domain allowlisting and transcript controls. Absent on a project that has never configured it. Writing this block requires a plan entitlement.
Show child attributes
/v1/stable/widgetChanges the widget configuration on the environment's draft version, such as its surface, colors, launcher, disclaimers, or approved domains. The change reaches visitors once the environment is published.
curl --request PATCH \
--url 'https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "chat",
"chat": {
"renderMode": "<WidgetSettingsChatRenderMode>",
"headerImage": "<WidgetSettingsChatSettingsHeaderImage>",
"agentImage": "<WidgetSettingsChatSettingsAgentImage>",
"banner": "<WidgetSettingsChatSettingsBanner>",
"placeholderText": "<string>",
"disclaimer": "<WidgetSettingsChatDisclaimer>",
"aiDisclaimer": "<WidgetSettingsChatSettingsAIDisclaimer>",
"handoffToAgentImageURL": "<string>",
"streamingDisabled": true,
"responseLoader": "<WidgetSettingsChatSettingsResponseLoader>",
"voiceInput": true,
"voiceOutput": true,
"voiceOutputMuted": true,
"voiceMode": true,
"notificationSound": true,
"fileUpload": "<WidgetSettingsChatSettingsFileUpload>",
"csat": "<WidgetSettingsChatSettingsCSAT>"
},
"voice": {
"renderMode": "<WidgetSettingsVoiceRenderMode>",
"content": "<WidgetSettingsVoiceSettingsContent>"
},
"common": {
"sideSpacing": "<string>",
"bottomSpacing": "<string>",
"width": "<string>",
"position": "<WidgetSettingsWidgetPosition>",
"fontFamily": "<string>",
"primaryColor": {
"color": "<string>",
"palette": "<WidgetSettingsColorPalette>"
},
"poweredBy": true,
"launcher": "<WidgetSettingsCommonSettingsLauncher>",
"footerLink": "<WidgetSettingsCommonSettingsFooterLink>",
"persistence": "<WidgetSettingsChatPersistence>",
"featureFlags": "<WidgetSettingsCommonSettingsFeatureFlags>"
},
"security": {
"approvedDomains": "<WidgetSettingsSecuritySettingsApprovedDomains>",
"disableTranscript": true,
"isTranscriptDownloadEnabled": true
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"type": "chat",
"chat": {
"renderMode": "<WidgetSettingsChatRenderMode>",
"headerImage": "<WidgetSettingsChatSettingsHeaderImage>",
"agentImage": "<WidgetSettingsChatSettingsAgentImage>",
"banner": "<WidgetSettingsChatSettingsBanner>",
"placeholderText": "<string>",
"disclaimer": "<WidgetSettingsChatDisclaimer>",
"aiDisclaimer": "<WidgetSettingsChatSettingsAIDisclaimer>",
"handoffToAgentImageURL": "<string>",
"streamingDisabled": true,
"responseLoader": "<WidgetSettingsChatSettingsResponseLoader>",
"voiceInput": true,
"voiceOutput": true,
"voiceOutputMuted": true,
"voiceMode": true,
"notificationSound": true,
"fileUpload": "<WidgetSettingsChatSettingsFileUpload>",
"csat": "<WidgetSettingsChatSettingsCSAT>"
},
"voice": {
"renderMode": "<WidgetSettingsVoiceRenderMode>",
"content": "<WidgetSettingsVoiceSettingsContent>"
},
"common": {
"sideSpacing": "<string>",
"bottomSpacing": "<string>",
"width": "<string>",
"position": "<WidgetSettingsWidgetPosition>",
"fontFamily": "<string>",
"primaryColor": {
"color": "<string>",
"palette": "<WidgetSettingsColorPalette>"
},
"poweredBy": true,
"launcher": "<WidgetSettingsCommonSettingsLauncher>",
"footerLink": "<WidgetSettingsCommonSettingsFooterLink>",
"persistence": "<WidgetSettingsChatPersistence>",
"featureFlags": "<WidgetSettingsCommonSettingsFeatureFlags>"
},
"security": {
"approvedDomains": "<WidgetSettingsSecuritySettingsApprovedDomains>",
"disableTranscript": true,
"isTranscriptDownloadEnabled": true
}
}),
});
const data = await response.json();import requests
response = requests.patch(
'https://realtime-api.voiceflow.com/v1/stable/widget?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"type": "chat",
"chat": {
"renderMode": "<WidgetSettingsChatRenderMode>",
"headerImage": "<WidgetSettingsChatSettingsHeaderImage>",
"agentImage": "<WidgetSettingsChatSettingsAgentImage>",
"banner": "<WidgetSettingsChatSettingsBanner>",
"placeholderText": "<string>",
"disclaimer": "<WidgetSettingsChatDisclaimer>",
"aiDisclaimer": "<WidgetSettingsChatSettingsAIDisclaimer>",
"handoffToAgentImageURL": "<string>",
"streamingDisabled": True,
"responseLoader": "<WidgetSettingsChatSettingsResponseLoader>",
"voiceInput": True,
"voiceOutput": True,
"voiceOutputMuted": True,
"voiceMode": True,
"notificationSound": True,
"fileUpload": "<WidgetSettingsChatSettingsFileUpload>",
"csat": "<WidgetSettingsChatSettingsCSAT>"
},
"voice": {
"renderMode": "<WidgetSettingsVoiceRenderMode>",
"content": "<WidgetSettingsVoiceSettingsContent>"
},
"common": {
"sideSpacing": "<string>",
"bottomSpacing": "<string>",
"width": "<string>",
"position": "<WidgetSettingsWidgetPosition>",
"fontFamily": "<string>",
"primaryColor": {
"color": "<string>",
"palette": "<WidgetSettingsColorPalette>"
},
"poweredBy": True,
"launcher": "<WidgetSettingsCommonSettingsLauncher>",
"footerLink": "<WidgetSettingsCommonSettingsFooterLink>",
"persistence": "<WidgetSettingsChatPersistence>",
"featureFlags": "<WidgetSettingsCommonSettingsFeatureFlags>"
},
"security": {
"approvedDomains": "<WidgetSettingsSecuritySettingsApprovedDomains>",
"disableTranscript": True,
"isTranscriptDownloadEnabled": True
}
},
)
data = response.json()vf widget update --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"type": "chat",
"chat": {
"renderMode": "<WidgetSettingsChatRenderMode>",
"headerImage": "<WidgetSettingsChatSettingsHeaderImage>",
"agentImage": "<WidgetSettingsChatSettingsAgentImage>",
"banner": "<WidgetSettingsChatSettingsBanner>",
"placeholderText": "<string>",
"disclaimer": "<WidgetSettingsChatDisclaimer>",
"aiDisclaimer": "<WidgetSettingsChatSettingsAIDisclaimer>",
"handoffToAgentImageURL": "<string>",
"streamingDisabled": true,
"responseLoader": "<WidgetSettingsChatSettingsResponseLoader>",
"voiceInput": true,
"voiceOutput": true,
"voiceOutputMuted": true,
"voiceMode": true,
"notificationSound": true,
"fileUpload": "<WidgetSettingsChatSettingsFileUpload>",
"csat": "<WidgetSettingsChatSettingsCSAT>"
},
"voice": {
"renderMode": "<WidgetSettingsVoiceRenderMode>",
"content": "<WidgetSettingsVoiceSettingsContent>"
},
"common": {
"sideSpacing": "<string>",
"bottomSpacing": "<string>",
"width": "<string>",
"position": "<WidgetSettingsWidgetPosition>",
"fontFamily": "<string>",
"primaryColor": {
"color": "<string>",
"palette": "<WidgetSettingsColorPalette>"
},
"poweredBy": true,
"launcher": "<WidgetSettingsCommonSettingsLauncher>",
"footerLink": "<WidgetSettingsCommonSettingsFooterLink>",
"persistence": "<WidgetSettingsChatPersistence>",
"featureFlags": "<WidgetSettingsCommonSettingsFeatureFlags>"
},
"security": {
"approvedDomains": "<WidgetSettingsSecuritySettingsApprovedDomains>",
"disableTranscript": true,
"isTranscriptDownloadEnabled": true
}
}
JSON{
"message": "<string>"
}Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Switches the embed between the text chat surface and the click-to-call voice surface. The surface you switch away from is kept as it was, so switching back later restores it.
chat, voiceChat-surface fields to change, merged one level deep into the stored chat block: what you send replaces its stored counterpart and everything else is kept. A nested object (banner, headerImage, disclaimer, csat, …) replaces the stored one outright, so send it complete. placeholderText and aiDisclaimer need the Webchat Premium entitlement and disclaimer the widget-security one: without it the whole request is refused with 403 and nothing is written, including the other fields sent alongside it.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Voice-surface fields to change, merged one level deep into the stored voice block. content is a nested object: it replaces the stored one outright, so send every line of call-screen copy, not just the one you are changing.
Show child attributes
Show child attributes
Shared-chrome fields to change, merged one level deep into the stored common block. A nested object (launcher, footerLink) replaces the stored one outright, so send it complete. primaryColor is the exception and merges too: send color on its own to recolor the widget and the shade palette is regenerated from it, send palette on its own to hand-tune the shades against the stored color, or send both together. poweredBy, fontFamily, footerLink and primaryColor.palette need the Webchat Premium entitlement — primaryColor.color on its own does not — and without it the whole request is refused with 403 and nothing is written, including the other fields sent alongside it.
Show child attributes
Show child attributes
The brand color, as 3- or 6-digit hex. Sent on its own it also regenerates palette from itself, which is the only way to recolor the widget without the Webchat Premium entitlement.
The ten shades derived from color, keyed 50 through 900. Send it to override the generated shades — that is the part which needs the Webchat Premium entitlement. Omit it to have it regenerated from color.
Show child attributes
Show child attributes
icon, label, bothShow child attributes
Replaces the stored security block in full — unlike the other blocks it has no partial form. Requires a plan entitlement: without one the whole request is refused with 403 and nothing is written, including the other fields sent alongside it.
Show child attributes
Response
200 - application/jsonConfirms the widget configuration was updated on the draft version. The body is a message only, so read the widget back to see the settings as they now stand.
A human-readable message confirming the update.
/v1/stable/widget/snippetReturns the script tag that embeds the chat widget on a website, filled in for this project and environment, to place before each page's closing body tag.
curl --request GET \
--url 'https://realtime-api.voiceflow.com/v1/stable/widget/snippet?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>' \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/widget/snippet?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/widget/snippet?projectID=<projectID>&environmentAlias=<environmentAlias>&version=<version>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf widget get-snippet --project-id <projectID> --environment-alias <environmentAlias> --version <version>{
"snippet": "<string>"
}Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Pins the embed to one version of the environment: draft, the version used when testing, or published, the version serving live traffic. Omit it to pin the snippet to published.
draft, publishedResponse
200 - application/jsonReturns the complete <script> tag to paste into the website, built from the environment's widget configuration at the requested version.
The complete <script> tag to paste into the website, just before the closing </body> of every page the widget should appear on. Already filled in with the right verification key, runtime endpoints and render block — it is meant to be copied verbatim, not edited.
Schemas
StableUpdateResponse
{"type":"object"}
| Property | Definition |
|---|---|
message · required | A human-readable message confirming the update. {"type":"string"} |
StableWidget
{"type":"object"}
| Property | Definition |
|---|---|
type · required | Which surface the embed runs: {"allOf":[{"$ref":"WidgetSettingsWidgetType"}],"enum":["chat","voice"],"x-enumNames":["CHAT","VOICE"]} |
chat · required | The chat surface, applied when {"allOf":[{"$ref":"WidgetSettingsChatSettings"}]} |
voice · required | The voice surface, applied when {"allOf":[{"$ref":"WidgetSettingsVoiceSettings"}]} |
common · required | Chrome shared by both surfaces: the launcher, the primary color and its palette, the font, the position and spacing on the page, the width, the Voiceflow footer link, and where the conversation is persisted between page loads. {"allOf":[{"$ref":"WidgetSettingsCommonSettings"}]} |
security | Approved-domain allowlisting and transcript controls. Absent on a project that has never configured it. Writing this block requires a plan entitlement. {"allOf":[{"$ref":"WidgetSettingsSecuritySettings"}]} |
StableWidgetGetSnippetResponse
{"type":"object"}
| Property | Definition |
|---|---|
snippet · required | The complete {"type":"string"} |
StableWidgetResponse
{"type":"object"}
| Property | Definition |
|---|---|
widget · required | The widget configuration stored on the environment's draft version. {"allOf":[{"$ref":"StableWidget"}]} |
StableWidgetUpdateRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
type | Switches the embed between the text {"type":"string","enum":["chat","voice"],"allOf":[{"$ref":"WidgetSettingsWidgetType"}],"x-enumNames":["CHAT","VOICE"]} |
chat | Chat-surface fields to change, merged one level deep into the stored {"type":"object","properties":{"renderMode":{"allOf":[{"$ref":"WidgetSettingsChatRenderMode"}]},"headerImage":{"allOf":[{"$ref":"WidgetSettingsChatSettingsHeaderImage"}]},"agentImage":{"allOf":[{"$ref":"WidgetSettingsChatSettingsAgentImage"}]},"banner":{"allOf":[{"$ref":"WidgetSettingsChatSettingsBanner"}]},"placeholderText":{"type":"string"},"disclaimer":{"allOf":[{"$ref":"WidgetSettingsChatDisclaimer"}]},"aiDisclaimer":{"allOf":[{"$ref":"WidgetSettingsChatSettingsAIDisclaimer"}]},"handoffToAgentImageURL":{"nullable":true,"type":"string"},"streamingDisabled":{"type":"boolean"},"responseLoader":{"allOf":[{"$ref":"WidgetSettingsChatSettingsResponseLoader"}]},"voiceInput":{"type":"boolean"},"voiceOutput":{"type":"boolean"},"voiceOutputMuted":{"type":"boolean"},"voiceMode":{"type":"boolean"},"notificationSound":{"type":"boolean"},"fileUpload":{"allOf":[{"$ref":"WidgetSettingsChatSettingsFileUpload"}]},"csat":{"allOf":[{"$ref":"WidgetSettingsChatSettingsCSAT"}]}}} |
voice | Voice-surface fields to change, merged one level deep into the stored {"type":"object","properties":{"renderMode":{"allOf":[{"$ref":"WidgetSettingsVoiceRenderMode"}]},"content":{"allOf":[{"$ref":"WidgetSettingsVoiceSettingsContent"}]}}} |
common | Shared-chrome fields to change, merged one level deep into the stored {"type":"object","properties":{"sideSpacing":{"type":"string"},"bottomSpacing":{"type":"string"},"width":{"type":"string"},"position":{"allOf":[{"$ref":"WidgetSettingsWidgetPosition"}]},"fontFamily":{"type":"string"},"primaryColor":{"type":"object","properties":{"color":{"type":"string","pattern":"^#(?:[\\da-f]{3}|[\\da-f]{6})$","description":"The brand color, as 3- or 6-digit hex. Sent on its own it also regenerates `palette` from itself, which is the only way to recolor the widget without the Webchat Premium entitlement."},"palette":{"description":"The ten shades derived from `color`, keyed `50` through `900`. Send it to override the generated shades — that is the part which needs the Webchat Premium entitlement. Omit it to have it regenerated from `color`.","allOf":[{"$ref":"WidgetSettingsColorPalette"}]}}},"poweredBy":{"type":"boolean"},"launcher":{"allOf":[{"$ref":"WidgetSettingsCommonSettingsLauncher"}]},"footerLink":{"allOf":[{"$ref":"WidgetSettingsCommonSettingsFooterLink"}]},"persistence":{"allOf":[{"$ref":"WidgetSettingsChatPersistence"}]},"featureFlags":{"allOf":[{"$ref":"WidgetSettingsCommonSettingsFeatureFlags"}]}}} |
security | Replaces the stored security block in full — unlike the other blocks it has no partial form. Requires a plan entitlement: without one the whole request is refused with 403 and nothing is written, including the other fields sent alongside it. {"allOf":[{"$ref":"WidgetSettingsSecuritySettings"}]} |
WidgetSettingsChatDisclaimer
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
title · required | {"type":"string"} |
description · required | {"type":"string"} |
primaryButtonText · required | {"type":"string"} |
secondaryButtonText · required | {"type":"string"} |
secondaryButtonURL · required | {"type":"string"} |
WidgetSettingsChatPersistence
{"type":"string","enum":["memory","localStorage","sessionStorage"],"x-enumNames":["MEMORY","LOCAL_STORAGE","SESSION_STORAGE"]}
WidgetSettingsChatRenderMode
{"type":"string","enum":["embed","widget","popover"],"x-enumNames":["EMBED","WIDGET","POPOVER"]}
WidgetSettingsChatSettings
{"type":"object"}
| Property | Definition |
|---|---|
renderMode · required | {"$ref":"WidgetSettingsChatRenderMode"} |
headerImage · required | {"$ref":"WidgetSettingsChatSettingsHeaderImage"} |
agentImage · required | {"$ref":"WidgetSettingsChatSettingsAgentImage"} |
banner · required | {"$ref":"WidgetSettingsChatSettingsBanner"} |
placeholderText · required | {"type":"string"} |
disclaimer | {"allOf":[{"$ref":"WidgetSettingsChatDisclaimer"}]} |
aiDisclaimer · required | {"$ref":"WidgetSettingsChatSettingsAIDisclaimer"} |
handoffToAgentImageURL | {"nullable":true,"type":"string"} |
streamingDisabled | {"type":"boolean"} |
responseLoader | {"allOf":[{"$ref":"WidgetSettingsChatSettingsResponseLoader"}]} |
voiceInput · required | {"type":"boolean"} |
voiceOutput · required | {"type":"boolean"} |
voiceOutputMuted | {"type":"boolean"} |
voiceMode | {"type":"boolean"} |
notificationSound | {"type":"boolean"} |
fileUpload | {"allOf":[{"$ref":"WidgetSettingsChatSettingsFileUpload"}]} |
csat | {"allOf":[{"$ref":"WidgetSettingsChatSettingsCSAT"}]} |
WidgetSettingsChatSettingsAIDisclaimer
{"type":"object"}
| Property | Definition |
|---|---|
text · required | {"type":"string"} |
enabled · required | {"type":"boolean"} |
WidgetSettingsChatSettingsAgentImage / WidgetSettingsChatSettingsHeaderImage
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
url | {"nullable":true,"type":"string"} |
WidgetSettingsChatSettingsBanner
{"type":"object"}
| Property | Definition |
|---|---|
title · required | {"type":"string"} |
description · required | {"type":"string"} |
enabled · required | {"type":"boolean"} |
imageURL | {"nullable":true,"type":"string"} |
WidgetSettingsChatSettingsCSAT
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
promptText | {"type":"string"} |
includeFreetextFeedback · required | {"type":"boolean"} |
WidgetSettingsChatSettingsFileUpload
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
maxFilesPerConversation | {"nullable":true,"type":"number"} |
model | {"type":"string"} |
WidgetSettingsChatSettingsResponseLoader
{"oneOf":[{"$ref":"WidgetSettingsChatSettingsResponseLoaderDots"},{"$ref":"WidgetSettingsChatSettingsResponseLoaderSpinnerWithText"}]}
WidgetSettingsChatSettingsResponseLoaderDots
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dots"],"x-enumNames":["DOTS"]} |
WidgetSettingsChatSettingsResponseLoaderSpinnerWithText
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["spinner-with-text"],"x-enumNames":["SPINNER_WITH_TEXT"]} |
text · required | {"type":"string"} |
WidgetSettingsColorPalette
{"type":"object"}
| Property | Definition |
|---|---|
50 · required | {"type":"string"} |
100 · required | {"type":"string"} |
200 · required | {"type":"string"} |
300 · required | {"type":"string"} |
400 · required | {"type":"string"} |
500 · required | {"type":"string"} |
600 · required | {"type":"string"} |
700 · required | {"type":"string"} |
800 · required | {"type":"string"} |
900 · required | {"type":"string"} |
WidgetSettingsCommonSettings
{"type":"object"}
| Property | Definition |
|---|---|
sideSpacing · required | {"type":"string"} |
bottomSpacing · required | {"type":"string"} |
width | {"type":"string"} |
position · required | {"$ref":"WidgetSettingsWidgetPosition"} |
fontFamily · required | {"type":"string"} |
primaryColor · required | {"$ref":"WidgetSettingsPrimaryColor"} |
poweredBy · required | {"type":"boolean"} |
launcher · required | {"$ref":"WidgetSettingsCommonSettingsLauncher"} |
footerLink · required | {"$ref":"WidgetSettingsCommonSettingsFooterLink"} |
persistence · required | {"$ref":"WidgetSettingsChatPersistence"} |
featureFlags | {"allOf":[{"$ref":"WidgetSettingsCommonSettingsFeatureFlags"}]} |
WidgetSettingsCommonSettingsFeatureFlags
{"type":"object","additionalProperties":{"type":"boolean"}}
WidgetSettingsCommonSettingsFooterLink
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
text | {"type":"string"} |
url | {"type":"string"} |
WidgetSettingsCommonSettingsLauncher
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"$ref":"WidgetSettingsLauncherType"} |
text | {"type":"string"} |
imageURL | {"nullable":true,"type":"string"} |
WidgetSettingsLauncherType
{"type":"string","enum":["icon","label","both"],"x-enumNames":["ICON","LABEL","BOTH"]}
WidgetSettingsPrimaryColor
{"type":"object"}
| Property | Definition |
|---|---|
color · required | {"type":"string"} |
palette · required | {"$ref":"WidgetSettingsColorPalette"} |
WidgetSettingsSecuritySettings
{"type":"object"}
| Property | Definition |
|---|---|
approvedDomains · required | {"$ref":"WidgetSettingsSecuritySettingsApprovedDomains"} |
disableTranscript · required | {"type":"boolean"} |
isTranscriptDownloadEnabled | {"type":"boolean"} |
WidgetSettingsSecuritySettingsApprovedDomains
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | {"type":"boolean"} |
domains · required | {"type":"string"} |
WidgetSettingsVoiceRenderMode
{"type":"string","enum":["full","compact","expand"],"x-enumNames":["FULL","COMPACT","EXPAND"]}
WidgetSettingsVoiceSettings
{"type":"object"}
| Property | Definition |
|---|---|
renderMode · required | {"$ref":"WidgetSettingsVoiceRenderMode"} |
content · required | {"$ref":"WidgetSettingsVoiceSettingsContent"} |
WidgetSettingsVoiceSettingsContent
{"type":"object"}
| Property | Definition |
|---|---|
imageURL | {"nullable":true,"type":"string"} |
talkingText · required | {"type":"string"} |
endButtonText · required | {"type":"string"} |
listeningText · required | {"type":"string"} |
startButtonText · required | {"type":"string"} |
callToActionText · required | {"type":"string"} |
WidgetSettingsWidgetPosition
{"type":"string","enum":["right","left"],"x-enumNames":["RIGHT","LEFT"]}
WidgetSettingsWidgetType
{"type":"string","enum":["chat","voice"],"x-enumNames":["CHAT","VOICE"]}
Was this page helpful?
Thanks for your feedback.