Sign in
Chat Widget

Init Conversation

Initialize a new chat conversation.

Called by the widget when a user first opens it. Returns a session token, conversation ID, widget theming config, and the greeting message.

post/chat/init

Request body

firm_idstring required

Embed identifier: a chat widget ID (new snippets) or a customer/firm ID (legacy snippets, resolves to the default widget)

origin_urlstring nullable

Page URL where chat was started

visitor_idstring nullable

Persistent visitor identifier from localStorage for grouping conversations

is_testboolean

Whether this is a test conversation (excluded from pipeline/lead generation)

visitor_languagestring nullable

Visitor's browser language tag (e.g., 'es-419'); resolved against the supported-language registry

Response

Successful Response

conversation_idstring uuid required
session_tokenstring required
language_codestring

Changes