> ## Documentation Index
> Fetch the complete documentation index at: https://wabis.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Chat Widget

> Design your website chat widget, choose its layout and behavior, and install it on your site.

## What is this?

The **Chat Widget** builder lets you create and customize the chat widget that appears on your website. You edit each setting group in its own tab and see the result in a **Live Preview** panel beside them, then copy the installation code onto your site.

![The Chat Widget builder showing the settings tabs on the left and the Live Preview panel on the right](https://mintcdn.com/wabis/b8QJIW0SgwumJWX0/images/widget-builder-overview.png?fit=max\&auto=format\&n=b8QJIW0SgwumJWX0\&q=85\&s=7a30aff29934d18a1771057dbbb02488)

> [!NOTE]
>
> The builder requires the `widgetbuilder:view` permission, an active channel with Web Chat connected, and a plan that includes Web Chat. Some options — such as brand customization of the "Powered by" text — depend on your plan.

## What can I do here?

* Choose a **Style Preset**, **Primary Color**, **Accent Color**, **Company Logo URL**, and **Widget Position**
* Pick a **Home Screen Layout**: **Messenger**, **Help Center**, or **Contact**
* Turn **Live Chat** on or off, require cookie consent, and set up **Proactive Chat** invitations
* Manage team member avatars, help category shortcuts, or quick action buttons, depending on the layout
* Fine-tune **Font Family**, **Button Style**, **Shadow Intensity**, and **Animation Speed** under **Advanced**
* Copy the **Installation Code** for your website
* Preview the widget — including its home, article, and chat screens — before you publish

## How to use it

Go to **Web Chat → Chat Widget**. Each tab has its own **Save** button — save the tab you're editing before you switch to another one. The **Messenger Layout**, **Help Center Layout**, and **Contact Layout** tabs, and the tabs that go with them, appear according to the **Home Screen Layout** you choose on the **Widget Style** tab.

> [tab] Widget Style
>
> 1. Choose a **Style Preset**: **Modern** (gradient backgrounds), **Classic** (solid colors), or **Minimal** (clean and simple).
> 2. Set the **Primary Color** and **Accent Color**, and enter a **Company Logo URL**.
> 3. Choose the **Widget Position**: **Bottom Right**, **Bottom Left**, **Top Right**, or **Top Left**.
> 4. Choose the **Home Screen Layout** — **Messenger**, **Help Center**, or **Contact** — which decides what visitors see when the widget opens.
> 5. Click **Save**.
>
>    ![The Widget Style tab showing the style preset, colors, logo URL, and position options beside the Live Preview](https://mintcdn.com/wabis/b8QJIW0SgwumJWX0/images/widget-builder-style-tab.png?fit=max\&auto=format\&n=b8QJIW0SgwumJWX0\&q=85\&s=0623e6f12ae97c2c051a96cf853c2da3)

> [tab] Behavior
>
> * **Live Chat** — turn on **Enable Live Chat** to allow real-time messaging with visitors.
> * **Business Hours** — managed once per channel. Set them with the clock button next to the channel switcher; the widget uses that schedule for online and offline status.
> * **Privacy & Consent** — turn on **Require cookie consent** to show a consent banner before visitor location tracking.
> * **Proactive Chat** — turn on **Enable proactive invite** to show a chat prompt without waiting for a click. Set a **Delay (seconds)**, an **Invite message**, and optional triggers such as **URL contains** (for example `/pricing`), a **URL regex**, a **Scroll percent**, or **Exit intent**. Choose whether to **Auto-open widget** and to **Show once per session**.

> [tab] Messenger Layout
>
> A chat-focused layout with team avatars. Set the **Button Text** (for example "Send us a message"), **Search Placeholder**, and **Articles to Display**, and turn **Show Team Avatars** and **Show Recent Articles** on or off.

> [tab] Team Members
>
> Add each person shown in the Messenger layout with their **Name**, **Role**, and optional **Profile photo URL**. Use **Add Team Member** to add more, or **Remove** to delete one.

> [tab] Help Center Layout
>
> A knowledge base–first layout. Set the title, search placeholder, **Categories Title**, and **Chat Button Text**. Manage the articles themselves in the [Knowledge Base](https://wabis.mintlify.site/workspace/web-chat/widget-builder-kb.md).

> [tab] Help Categories
>
> Add category shortcuts with **Add Category**. Each has an **Icon**, **Label**, **Description**, and the **Knowledge Base category** it links to.

> [tab] Contact Layout
>
> A quick-actions layout with a status message. Set the **Title**, and turn on **Show Status Message** with text such as "We typically reply within a few minutes".

> [tab] Quick Actions
>
> Add action buttons with **Add Quick Action**, each with a label and an optional URL.

> [tab] Advanced
>
> Choose the **Font Family** (System Default, Inter, Roboto, or Open Sans), **Button Style** (Solid Fill, Outline, or Gradient), **Shadow Intensity** (None to Strong), and **Animation Speed** (None to Fast).

> [tab] Installation Code
>
> 1. Click the copy button on the code block.
>
> 2. Paste the code into your website's HTML.
>
> 3. Open your live site to confirm the widget appears.
>
>    ![The Installation Code tab showing the widget script and the copy button](https://mintcdn.com/wabis/b8QJIW0SgwumJWX0/images/widget-builder-installation.png?fit=max\&auto=format\&n=b8QJIW0SgwumJWX0\&q=85\&s=3229ced429029ab249cfb0d838cf8934)
>
> > [!WARNING]
> >
> > The widget's domain must be a valid **HTTPS** URL, such as `https://www.example.com`. Saving fails with an "Invalid domain" message otherwise.

## Troubleshooting / Technical Notes

* **"Please save your web chat widget first to manage."** Create and save the widget before using Live Monitoring or the Knowledge Base.
* **"Invalid domain."** Use a valid HTTPS URL for your site.
* **The widget doesn't appear on my site.** Confirm the installation code is on the page and the page uses HTTPS. Then open [Live Monitoring](https://wabis.mintlify.site/workspace/web-chat/widget-builder-monitoring.md) to see whether visits are being recorded.
* **Changes aren't showing.** Click **Save** on the tab you edited — each tab saves separately.
* **Brand customization is locked.** "Upgrade your plan to enable brand customization" means your plan doesn't include changing the **Powered By** text.

## Related docs

* [Web Chat overview](https://wabis.mintlify.site/workspace/web-chat/overview.md)
* [Live Monitoring](https://wabis.mintlify.site/workspace/web-chat/widget-builder-monitoring.md)
* [Knowledge Base](https://wabis.mintlify.site/workspace/web-chat/widget-builder-kb.md)
* [Channels](https://wabis.mintlify.site/workspace/channels/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.