livechat
livechat

Get Widget

Get a specific LiveChat widget.

get/api/livechat/widgets/{widget_id}

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/{widget_id}
  • Auth: none declared

Path parameters

widget_idinteger required

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 5 revisions of this API.