Widget
Public chat widget configuration and install snippet (admin-managed).
Get widget settings
Returns the current tenant's effective PUBLIC chat-widget configuration
Update widget settings
Partial update of the tenant widget configuration. Admin only. Every
Get widget install info
Returns the tenant's PUBLIC `widget_key` and a ready-to-paste embed
Get the tenant's CAPTCHA key status (admin)
Returns the tenant's own bot-verification (Turnstile) configuration. The
Set the tenant's CAPTCHA keys (admin)
Sets the tenant's own Turnstile keys. The site key is public; the secret
Get the tenant's visitor-push (OneSignal) status (admin)
Returns the tenant's OneSignal credentials status for widget visitor
Set the tenant's visitor-push (OneSignal) credentials (admin)
Sets the tenant's OneSignal app id, service-worker path and REST key for
Upload the tenant's push branding logo (admin)
Uploads the logo used as the push-notification icon (visitor push +
Remove the tenant's push branding logo (admin)
Clears the push logo, reverting notifications to the provider default. Admin only.
Upload the chat bot's profile photo (admin)
Uploads the avatar shown next to bot replies in the widget. Must be a
Remove the chat bot's profile photo (admin)
Clears the bot avatar; bot replies fall back to no avatar. Admin only.
Upload the header brand image / logo (admin)
A PNG/JPG/WebP image (48–3000 px, ≤ 4 MB) shown in the 'brand' header
Remove the header brand image (admin)
Remove the header brand image (admin)
Upload the header background image (admin)
A PNG/JPG/WebP image (48–3000 px, ≤ 4 MB) applied as the header
Remove the header background image (admin)
Remove the header background image (admin)
Upload the popup-message profile image (admin)
A PNG/JPG/WebP image (48–3000 px, ≤ 4 MB) shown as the avatar in the
Remove the popup-message profile image (admin)
Remove the popup-message profile image (admin)
Upload a custom chat-button (launcher) icon (admin)
A PNG/JPG/WebP image (48–3000 px, ≤ 4 MB) used as the launcher icon,
Remove the custom chat-button icon (admin)
Remove the custom chat-button icon (admin)
Register a visitor's OneSignal push subscription
Binds the visitor's OneSignal subscription id (from the widget's
Start or resume a visitor chat session
PUBLIC endpoint (anonymous website visitors, NO staff auth). The tenant
Create the conversation for a deferred visitor (first write)
PUBLIC endpoint (anonymous visitors, NO staff auth). Deferred-conversation
List selectable agents for the widget agent menu
PUBLIC endpoint (anonymous visitors). The agents a visitor may choose to
List the logged-in account's past chats (widget)
PUBLIC endpoint, AUTHENTICATED session only (403 otherwise). Returns the
Start a new chat as the logged-in account (widget)
PUBLIC endpoint, AUTHENTICATED session only. Opens a fresh chat on the
Continue a past chat as the logged-in account (widget)
PUBLIC endpoint, AUTHENTICATED session only. Resumes one of the account's
Close (archive) the logged-in account's own chat (widget)
PUBLIC endpoint, AUTHENTICATED session only. Archives one of the account's
Register a website end-user account (widget)
PUBLIC endpoint. Creates a website end-user account (separate from staff
Email a passwordless sign-in (magic) link (widget)
PUBLIC endpoint. ALWAYS returns 200 (never reveals whether the email
Exchange a magic-link token for a session (widget)
PUBLIC endpoint. The widget reads the `sb_login` token from the page URL
Log in a website end-user account (widget)
PUBLIC endpoint. Verifies the email + password and returns an
Single sign-on from a connected store (widget)
PUBLIC endpoint. Exchanges a SIGNED token from the store's plugin (a
Log out (widget)
PUBLIC endpoint. Logout is client-side (the widget drops the stateless
The current logged-in end-user (widget)
PUBLIC endpoint. Returns the account bound to the presented AUTHENTICATED
Request a password-reset code (widget)
PUBLIC endpoint. Emails a one-time reset CODE to the account if it exists.
Reset the password with an emailed code (widget)
PUBLIC endpoint. Consumes the emailed code and sets a new password. A
Confirm the logged-in member's email (widget)
PUBLIC endpoint. Confirms the AUTHENTICATED member's email with the code
Re-send the email-verification code (widget)
PUBLIC endpoint. Re-emails the verification code to the AUTHENTICATED
Confirm the logged-in member's phone (widget)
PUBLIC endpoint. Confirms the AUTHENTICATED member's phone with the SMS
Re-send the SMS phone-verification code (widget)
PUBLIC endpoint. Re-texts the verification code to the AUTHENTICATED
Update the logged-in member's profile (widget)
PUBLIC endpoint. Partial self-service update of the AUTHENTICATED member's
Change the logged-in member's password (widget)
PUBLIC endpoint. Verifies the current password and sets a new one for the
Upload the logged-in member's avatar (widget)
PUBLIC endpoint. Multipart image upload for the AUTHENTICATED member's
Submit follow-up lead-capture details (anonymous visitor)
PUBLIC endpoint (anonymous visitor, no staff auth). Saves the visitor's
The visitor calls us from the widget
PUBLIC endpoint (anonymous visitor, no staff auth). The visitor's SDP
The visitor hangs up their own call
PUBLIC endpoint. The call id is checked against the token's own
Rate the visitor's own conversation (CSAT)
PUBLIC endpoint (anonymous visitor, no staff auth). Records a 1–5
List visitor conversation history
PUBLIC endpoint (anonymous visitors, NO staff auth). Returns a page of
Send a visitor message
PUBLIC endpoint (anonymous visitors, NO staff auth). Sends a message in
Upload visitor file attachments
PUBLIC endpoint (anonymous visitors, NO staff auth). Uploads one or more
Start an AI tool run from the widget
PUBLIC endpoint (anonymous visitors, NO staff auth) — doc 97 §13. Starts a
Poll the visitor's own AI tool run
PUBLIC endpoint — doc 97 §13. The visitor's OWN run only (another
The visitor is (or stopped) typing
PUBLIC endpoint (anonymous visitors, NO staff auth). Tells the agents
Request a human agent
PUBLIC endpoint (anonymous visitors, NO staff auth). The visitor asks to
Answer a pending takeover offer
PUBLIC endpoint (anonymous visitors, NO staff auth). The visitor answers
Advance a deterministic flow
PUBLIC endpoint (anonymous visitors, NO staff auth). The visitor advances
Authorize a visitor realtime channel
PUBLIC Pusher-compatible broadcasting authorization for anonymous widget