Installation
Installation
Add the widget with a script tag, then pick a display mode and theme.
Identity verification
Identity verification
Sign users in with a signed JWT so the agent knows who it’s talking to.
Conversations
Conversations
Read what customers ask and how the agent answered.
JavaScript API
JavaScript API
Boot, show, hide, and theme the widget from your code.
Policies
Policies
Give the agent a fixed procedure for refunds, cancellations, and other requests your team handles the same way every time.
Create a widget
- In the sidebar, under Channels, open Widgets and click New widget.
-
Give it a name, like
Main website. -
Under Allowed domains, add the sites that may load it, like
acme.com. Leave it empty to allow any site. - Click Create widget. The widget opens on Setup, with its embed snippet ready to copy.
- Copy the Embed snippet into your site. Installation covers display modes and single-page apps.
Configure it
Each widget has four tabs. A preview beside them shows your changes as you make them.Setup
The Embed snippet, the Widget ID, and your Logo (JPEG or PNG, 64×64 px recommended).Regenerate on the widget ID breaks every site that has the widget installed until you replace the snippet.
Appearance
- Colors: hex values for primary, background, border, and text. Leave one empty to keep the default.
- Layout: Floating, Overlay sidebar, or Push sidebar, with the panel’s size and offsets in CSS lengths like
380px. Turn on Hide launcher button if you’ll open the widget from your own code. - Content: the header title, greeting, and input placeholder.
- Suggested messages: up to 6 quick replies shown when the widget opens, 80 characters each.
Security
- Allowed domains: the sites that can load the widget.
- Identity verification: turn on Verify customers to know who’s asking, using your backend, Zendesk Help Center, Auth0, or another OIDC provider. Identity verification walks through each.
- Sessions: how long a customer can come back to the same conversation, set separately for anonymous and logged-in customers.
Behavior
- Custom instructions: what the agent should always do in this widget, like “Answer in the customer’s language” or “Mention the 30-day trial for pricing questions”. They can’t override safety guardrails.
- Escalation: where a conversation goes when the customer asks for a person. Pick a connected Plain, Pylon, Linear, Zendesk, or Salesforce integration, and the ticket opens there with the conversation attached. Plain lets you set the thread’s tier, and Linear the team and project.