Skip to main content
POST
Start a widget session

Query Parameters

website_token
string
required

The web-widget inbox's public token, as it appears in your widget snippet. Required on every widget request.

Example:

"EXAMPLE_WEBSITE_TOKEN"

Response

Success

Everything the widget needs to render itself, plus the session token for every later call.

website_channel_config
object

Widget appearance, enabled features, locales, pre-chat form, working hours — and auth_token, the session token to send as X-Auth-Token from here on.