Skip to main content
Configure the widget through HTML data attributes on the script tag or through the JavaScript API.
The production widget is AI-first. Embed and SDK configuration customize the experience; they do not select a widget version or change how a conversation starts. Live-support handoff remains available from the AI conversation.

Script Tag Attributes

Full Example

Script tag attributes are the fastest way to get started. For dynamic configuration — such as changing colors based on the page or passing user metadata — use the programmatic API instead.

Programmatic Configuration

For full control, create a widget instance with the JavaScript API:
When using the programmatic API, do not include data-assistant-id on the script tag. The script’s auto-initialization runs only when that attribute is present.

Authentication Modes

Anonymous

The default mode. Visitors are tracked by an automatically generated visitor ID stored in the browser. No login required. Best for public-facing websites.

Authenticated

Requires visitors to log in through Auth0 before chatting. Use this for internal tools or customer portals where you need verified identities.

Auto

A hybrid mode. If the visitor is already logged in through Auth0 on your site, the widget uses their authenticated identity. Otherwise, it falls back to anonymous mode.

Appearance

Brand Color

The primary color controls the chat bubble, header, send button, and accent elements.

Position

Behavior

The production composer supports text messages, quick replies, forms, and live support handoff. Attachments, browser voice input, and plugin-rendered widget UI are fast-follow capabilities. Legacy or SDK configuration fields for those features do not make their controls available in the production v2 composer.

Suggested Messages

Display clickable chips when the chat panel opens to guide visitors:
Show floating teaser bubbles above the launcher button to draw visitors in — distinct from Suggested Messages, which appear inside the chat panel. Clicking a bubble opens the chat; visitors can dismiss bubbles, and dismissals are remembered per visitor. The easiest way to configure popup messages is in the dashboard under Widget → Styles → Popup messages — set up to 3 messages and a delay, and they apply everywhere the widget is installed without touching your embed code. You can also configure them programmatically:
Configuration passed in code takes priority over dashboard settings on that page. If popupMessages is not set, the bubbles fall back to showing your suggestedMessages list.

Auto-Open

Automatically open the chat panel after a delay (in milliseconds):
Use auto-open sparingly. A delay of 3 to 10 seconds works well for most use cases.

Session Persistence

Sessions persist across page loads by default, so visitors do not lose their conversation when navigating your site:

Metadata

Attach custom key-value pairs to every conversation for filtering and analytics:

Lead Capture

Lead capture collects visitor information (name, email, phone) before or during a conversation. Configure it in your assistant’s settings:
  1. Open your assistant’s Settings page
  2. Navigate to the Widget tab
  3. Toggle Lead Capture on
  4. Choose which fields to collect
  5. Save your changes
Listen for lead submissions:

Rollout

Rollout controls where and for whom the launcher appears, so you can test on a real page before going live for everyone. Set it on your assistant’s Embed page, under Rollout. There are three modes:
The widget is live for all visitors on every page where the embed code is installed.
The launcher only appears on URL paths you list — one glob per line, each starting with /. Use * to match anything:
/products/* matches /products/shoes and /products/shoes/blue. This is a client-side rule — it decides whether the launcher mounts based on the page URL.
Rollout controls launcher visibility. It does not select a v1/v2 renderer, change the AI-first conversation behavior, or throttle traffic by percentage. The secret test token is never exposed in the widget’s public configuration.

Next Steps

SDK Reference

Full JavaScript API documentation for programmatic widget control.

Installation

Framework-specific installation guides.