Reference
WebIntegration Data Model
The full WebIntegration record - every field the dashboard manages
A Web Messenger is a WebIntegration record on your organisation. This page lists the fields the dashboard stores. For the runtime config the widget consumes, see WidgetConfig.
Top-level
| Field | Type | Meaning |
|---|---|---|
_id | id | Integration id. |
name | string | Internal label, up to 100 characters. Never shown to visitors. |
publicKey | string | Embed identity (pk_live_…). Public. |
allowedOrigins | string[] | Origins permitted to load the widget. Enforced server-side. |
disabled | boolean | When true, the widget is paused. |
defaultTab | enum | Tab the widget opens on. Default HOME. |
createdAt / updatedAt | datetime | Timestamps. |
aiAutoReply
| Field | Meaning |
|---|---|
mode | org-default, specific, or disabled. |
assistantId | Which AI assistant answers visitors (with specific). |
theme
| Field | Meaning |
|---|---|
light / dark | Two palettes, each with the 16 tokens. |
radii | sm, md, lg, xl (px). |
themeMode | light / dark / auto. |
fontFamily | Widget font stack. |
launcherPosition | Screen corner for the launcher. |
launcherOffset | x and y in px, moving the launcher away from its corner. |
homeBackdropGlow | Turns the Home backdrop glow on or off. |
Palette tokens (×16, per mode): background, surface, surfaceElevated, text, textMuted, textSubtle, border, borderStrong, primary, primaryHover, primaryForeground, launcherBackground, launcherForeground, homeBackdrop, success, danger.
features
Surface toggles: home, messenger, help, news, profile.
security
| Field | Meaning |
|---|---|
requireAuth | Force sign-in before messaging. |
google.enabled / google.clientId | Google sign-in. |
passkey.enabled | Passkey sign-in. |
tracking
| Field | Meaning |
|---|---|
trackWidgetLinks | Record clicks on links inside the widget. On by default. |
trackWebsitePages | Record the pages a visitor views on your site. On by default. |
See Analytics.
botProtection
| Field | Meaning |
|---|---|
turnstileEnabled | Cloudflare Turnstile on/off. |
turnstileSiteKey | Turnstile site key. The secret key is stored encrypted and never returned. |
branding
| Field | Meaning |
|---|---|
hidden | Hide the Wexio badge. Pro and Enterprise only. |
Media and Avatars
| Field | Meaning |
|---|---|
logo | light and dark media uploads. |
showLogoInLauncher | Show the header logo on the launcher instead of the default icon. Off by default. |
operatorAvatars[] | Each has alt text + a media reference. |
Copy (Translatable)
Translatable fields keep the base value on the field and locale overrides in a matching …I18n field.
| Field | Meaning |
|---|---|
greeting | headline, subheadline. Overrides in greetingI18n. |
messenger | Title, description, AI avatar, commands, messages[], related-content + reaction toggles, profile field order. Overrides in messengerI18n. |
prechatForm | enabled + fields[] (kind, key, label, required). Overrides in prechatFormI18n. |
homeLayout | Ordered Home blocks. Per-locale copy in homeLayoutI18n. |
sounds
| Field | Meaning |
|---|---|
enabled / volume | Master toggle + volume. |
inbound / outbound | Each is a built-in preset id or an uploaded media reference. |
Localisation
| Field | Meaning |
|---|---|
defaultLocale | Base language (default en). |
supportedLocales[] | All offered languages. |
contentLocaleFallback | Fallback for untranslated content. |
localeStrategy | How the active locale is chosen per visitor. |
Not on the Record
- Shared secret. Returned only at creation or rotation. It is never stored on the read model or sent to the page.
- Help articles, folders, and tags, and news posts, categories, and tags. These are separate collections scoped to the integration.
- Knowledge chunks. Derived automatically from published help articles for AI retrieval.
Related
- Configuration - the runtime config the widget consumes.
- Create a Widget - provision the integration.
- Help Center - the help articles stored outside the record.