Reference

WebIntegration Data Model

The full WebIntegration record — every field the dashboard manages

A Web Messenger is a WebIntegration record on your organisation. This is the field reference for what the dashboard stores; for the runtime config the widget consumes, see WidgetConfig.

Top-level

FieldTypeMeaning
_ididIntegration id.
namestringInternal label (1–100 chars). Not visitor-facing.
publicKeystringEmbed identity (pk_live_…). Public.
allowedOriginsstring[]Origins permitted to load the widget. Enforced server-side.
disabledbooleanWhen true, the widget is paused.
defaultTabenumTab the widget opens on.
createdAt / updatedAtdatetimeTimestamps.

aiAutoReply

FieldMeaning
modeorg-default, specific, or disabled.
assistantIdWhich AI assistant answers visitors (with specific).

theme

FieldMeaning
light / darkTwo palettes, each with the 15 tokens.
radiism, md, lg, xl (px).
themeModelight / dark / auto.
fontFamilyWidget font stack.
launcherPositionScreen corner for the launcher.

Palette tokens (×15, per mode): background, surface, surfaceElevated, text, textMuted, textSubtle, border, borderStrong, primary, primaryHover, primaryForeground, launcherBackground, launcherForeground, success, danger.

features

Surface toggles: home, messenger, help, news, profile.

security

FieldMeaning
requireAuthForce sign-in before messaging.
google.enabled / google.clientIdGoogle sign-in.
passkey.enabledPasskey sign-in.

botProtection

FieldMeaning
turnstileEnabledCloudflare Turnstile on/off.
turnstileSiteKeyTurnstile site key.

branding

FieldMeaning
hiddenHide the "Powered by Wexio" badge. Pro+ only.

Media & avatars

FieldMeaning
logolight and dark media uploads.
operatorAvatars[]Each has alt text + a media reference.

Copy (translatable)

Translatable fields store the base value on the field and locale overrides in a matching …I18n field.

FieldMeaning
greetingheadline, subheadline. Overrides in greetingI18n.
messengerTitle, description, AI avatar, commands, messages[], related-content + reaction toggles, profile field order. Overrides in messengerI18n.
prechatFormenabled + fields[] (kind, key, label, required). Overrides in prechatFormI18n.
homeLayoutOrdered Home blocks. Per-locale copy in homeLayoutI18n.

sounds

FieldMeaning
enabled / volumeMaster toggle + volume.
inbound / outboundEach is a built-in preset id or an uploaded media reference.

Localisation

FieldMeaning
defaultLocaleBase language (default en).
supportedLocales[]All offered languages.
contentLocaleFallbackFallback for untranslated content.
localeStrategyHow the active locale is chosen per visitor.

Not on the record

  • Shared secret — returned only at creation/rotation, never stored on the read model or sent to the page.
  • Help articles / folders / tags and news posts / categories / tags — separate collections scoped to the integration.
  • Knowledge chunks — derived automatically from published help articles for AI retrieval.

On this page