---
title: "Embed the help widget"
url: "/help/buuk/embed-the-help-widget"
updated: "2026-11-15T11:35:31.100Z"
---
# Embed the help widget

The widget puts your help center inside your product. You install it once from Settings → Help widget, and readers get search, AI answers, and announcements grounded in your published docs without leaving your app.

## Install

Open Settings → Help widget. Each workspace gets a public key — it starts with wk_ — and a script URL. Copy them from the same page.

List the origins the widget may load on. Under Allowed origins, add one origin per line, for example https://app.yourproduct.com. Without your product origin in the list, the embed opens but shows no articles.

Paste the embed snippet into your app's HTML on each origin you allow. A standalone preview also runs at /widget/<your-public-key> if you want to see it before touching your app.

```html
<script src="https://app.getbuuk.com/api/widget/script.js?key=wk_xxxxxxxxxxxx" async></script>
```

Then turn on Enable widget. New widgets start turned off, so the snippet alone does nothing until you switch it on.

Load your product and check the launcher in the corner. If nothing appears, the widget is off, the snippet is missing, the script failed to load, or the origin is not on the allowlist yet.

The public key identifies your workspace — it carries no secret of its own, so embedding it in a public page is safe. What the widget presents comes from your published content and your settings.

## What the widget can do

- Home tab with greeting, suggested articles, Home links and an ask CTA
- Launcher in either corner, as a round icon or a labelled pill
- Search across published docs
- Chat with Ask AI, with optional escalation to a live chat
- News tab fed by changelog entries you mark to announce
- Optional ElevenLabs Listen button on AI answers when you enable voice

Styling all of that is the Widget studio's job: logo, icon, colours, gradients, theme, font, greeting and Home links, with a live preview and an explicit Save.

Each feature has its own page, so this one stays about installing: Widget settings covers the public key, origins, voice and escalation; Widget features covers search, Ask AI, voice, announcements and escalation; Widget troubleshooting covers a script that will not load, CORS, and CSP.

## Safety

Allowed origins restrict where the script may serve docs, so a copy of the key cannot be used to serve your content from someone else's site. Rotate the key from the same settings page if it leaks — old embeds stop working until they pick up the new one — or disable the widget entirely with one switch.

Voice uses your workspace voice settings (voice id, autoplay, speed). Keep autoplay off if your product already has audio.

## Related

Key, origins and voice: Widget settings.

Look and feel: Widget studio.

What the widget does once installed: Widget features.

When the launcher never appears: Widget troubleshooting.