Skip to main content
POST
Broadcast visitor typing

Authorizations

X-Auth-Token
string
header
required

The signed session token from POST /api/v1/widget/config. Sent alongside website_token in the query string on every widget request. See /api-reference/widget-api-authentication.

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"

Body

application/json
typing_status
enum<string>
required

Whether the visitor is typing.

Available options:
on,
off

Response

Broadcast