livechat
livechat

Create Widget

Create a new LiveChat widget.

post/api/livechat/widgets

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/livechat/widgets
  • Auth: none declared

Request body

namestring
require_identificationboolean
identification_fieldsstring[]
identification_field_configobject nullable

Custom field rendering config. Keys are field names, values are {label, type, options?, required?}. type: 'text'|'email'|'tel'|'select'|'date'. options: list of strings for select type.

show_visitor_historyboolean
allowed_domainsstring[]
rate_limit_per_minuteinteger
calendly_urlstring nullable

Calendly/scheduling URL for calendar action (e.g., https://calendly.com/company/demo)

contact_form_fieldsstring[]

Available fields for contact form action

contact_form_field_configobject nullable

Per-field config overrides: {field_name: {label?, type?, placeholder?, options?}}

enable_search_actionboolean

Allow LLM to use search action in AUTO_REPLY_RULES

enable_form_actionboolean

Allow LLM to use form action to collect visitor info

enable_calendar_actionboolean

Allow LLM to use calendar action to send scheduling links

allow_attachmentsboolean

Allow visitors to upload file attachments (images, PDFs)

max_attachment_size_mbinteger

Maximum file size in MB for attachments

allowed_attachment_typesstring[]

Allowed MIME types for attachments

sound_enabledboolean

Play sound when new message arrives

site_search_enabledboolean

Enable direct product search on widget owner's website

website_urlstring nullable

Widget owner's website URL for product search (e.g., https://beautique-store.com)

ecommerce_platformstring nullable

E-commerce platform: shopify, woocommerce, generic, or null for auto-detect

allow_voiceboolean

Enable voice call mode in the widget

allow_text_during_callboolean

Allow typing messages during an active voice/avatar call

allow_avatarboolean

Enable avatar (talking-head video) call mode in the widget

show_brandingboolean

Show the 'Powered by DialogBrain' badge under the chat. Hiding it needs a paid plan for this widget.

voice_greetingstring nullable

First message the agent speaks when a voice call starts. Empty = agent waits.

voice_stt_modelstring nullable

STT model: 'flux' (context-aware turn detection) or 'nova-3' (classic)

max_voice_duration_secondsinteger

Maximum voice call duration in seconds

display_mode'chat' | 'voice_only' | 'headless'

Visual mode of the widget. 'chat' (default): full chat panel + mic. 'voice_only': mic-only bubble that launches a voice call directly. 'headless': no UI; customer drives the widget via window.DialogBrain.* JS API.

Response

Successful Response

idinteger required
widget_keystring required
namestring required
themeobject required
require_identificationboolean required
identification_fieldsstring[] required
identification_field_configobject nullable
show_visitor_historyboolean required
allowed_domainsstring[] required
rate_limit_per_minuteinteger required
is_activeboolean required
embed_codestring required
calendly_urlstring nullable
contact_form_fieldsstring[]
contact_form_field_configobject nullable
enable_search_actionboolean
enable_form_actionboolean
enable_calendar_actionboolean
proactive_greetingobject nullable
allow_attachmentsboolean
max_attachment_size_mbinteger
allowed_attachment_typesstring[]
sound_enabledboolean
site_search_enabledboolean
website_urlstring nullable
ecommerce_platformstring nullable
allow_voiceboolean
allow_text_during_callboolean
allow_avatarboolean
show_brandingboolean
can_hide_brandingboolean
max_voice_duration_secondsinteger
voice_stt_modelstring
voice_greetingstring
display_mode'chat' | 'voice_only' | 'headless'
localizationobject
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 6 revisions of this API.