Sign in
Chat Widget

Get Widget Config

Fetch widget configuration for a firm.

Called on page load so the bubble can render with the correct theme before the user opens the chat. Lightweight — no conversation created.

get/chat/config/{firm_id}

Path parameters

firm_idstring required

Response

Successful Response

chat_widget_idstring uuid nullable
firm_idstring uuid nullable
accent_colorstring required
secondary_colorstring nullable
positionstring required
greeting_messagestring required
assistant_namestring required
enabledboolean
teaser_enabledboolean
teaser_messagestring nullable
teaser_delay_secondsinteger
show_online_statusboolean
show_unread_badgeboolean
tab_notification_enabledboolean
avatar_urlstring nullable
avatar_video_urlstring nullable
avatar_video_in_headerboolean
launcher_avatar_enabledboolean
intro_video_enabledboolean
intro_video_urlstring nullable
intro_video_autoplay_on_loadboolean
attention_grabber_enabledboolean
attention_grabber_messagestring nullable
attention_grabber_delay_secondsinteger
idle_messagestring nullable
idle_delay_secondsinteger nullable
quick_exit_enabledboolean
mobile_bottom_offset_pxinteger nullable
default_languagestring nullable

Changes

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