Every aspect of the chatbot is controlled by data-* attributes on the script tag. The settings page produces the snippet for you, but the full reference is below in case you write the snippet by hand or generate it programmatically.
The full reference
| Attribute | Default | What it does |
|---|---|---|
data-site-key | (required) | Your site key issued at AI registration. |
data-agent-name | Support | Name shown in the chat header. |
data-agent-avatar | generic icon | URL of a square image shown next to the agent name. |
data-primary-color | #2563eb | Color of the launcher, header gradient, user message bubbles, and focus rings. |
data-position | right | right or left. Which corner the launcher sits in. |
data-welcome-message | Hi! I'm {agent}... | First message the bot posts when the panel opens. |
data-suggested-prompts | (none) | |-separated list of starter chips. Hidden after the first user message. |
data-input-placeholder | Type a message... | Greyed-out hint text inside the message box. |
data-launcher-label | (none) | Short text shown next to the launcher on hover. Leave blank for no tooltip. |
data-auto-open | none | none, delay, scroll, or exit-intent. Fires once per browsing session. |
data-auto-open-value | 5 / 50 | Seconds for delay, percent for scroll. Ignored for exit-intent. |
data-show-on | (all pages) | Comma-separated path patterns with * wildcards. Empty = show everywhere. |
data-hide-on | (none) | Same syntax as show-on. Hide rules win when a path matches both. |
data-business-hours | (always available) | e.g. mon-fri:9-17, sat:10-14. Visitor local time, end-exclusive. |
data-offline-message | We're currently offline... | Greeting shown outside business hours. |
data-offline-mode | message | message (greyed status + offline greeting) or hide (no launcher). |
data-panel-width | 400 | Pixel width of the open chat panel. Capped to viewport on small screens. |
data-panel-height | 620 | Pixel height. Capped to viewport. Fullscreen on phones. |
data-branding | on | off to hide the small “Powered by HelpWP” footer. |
URL targeting examples
data-show-on="/docs/*, /pricing" only on docs and pricing
data-hide-on="/checkout/*, /admin/*" everywhere except thoseThe match is against window.location.pathname only; query strings and fragments are ignored. Regex special characters are escaped, only * is treated as a wildcard.
Business hours examples
data-business-hours="mon-fri:9-17" office hours, weekdays
data-business-hours="mon-fri:9-17, sat:10-14" extended Saturdays
data-business-hours="sun-sat:0-24" equivalent to no ruleDay ranges wrap; fri-mon means Fri / Sat / Sun / Mon. Hours are end-exclusive, so 9-17 is 9:00 to 16:59.
Auto-open examples
data-auto-open="delay" data-auto-open-value="15" open after 15 seconds
data-auto-open="scroll" data-auto-open-value="60" open at 60% page scroll
data-auto-open="exit-intent" open when cursor leaves top edgeThe trigger fires at most once per sessionStorage lifetime, so visitors are not re-prompted on every page they view.
Switching it off cleanly
Set data-show-on="/never-match-this-path" (or just remove the script tag) to hide the widget on the entire site without removing the embed.
Was this doc helpful?