Skip to main content
POST
Create Web Widget

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Web widget configuration

voice_campaign_id
string
required

Global ID of the inbound campaign for this widget. Required.

Example:

"Vm9pY2VDYW1wYWlnbjoxMjM="

config
object
required

Widget appearance and behaviour configuration. Required. All fields inside config are optional and will use defaults if not provided.

Example:
voice_assistant_id
string

Provider-native ID of the voice assistant. Required when config.mode includes 'voice'.

Example:

"asst_abc123"

chat_assistant_id
string

Provider-native ID of the chat assistant. Required when config.mode includes 'chat'.

Example:

"asst_chat123"

Response

Web widget created successfully. Returns widget ID, campaign ID, and configuration.

status
string
Example:

"success"

message
string
Example:

"Web widget created successfully"

data
object