Skip to content

Settings

Complete reference for window.InviaroSettings. Required fields are marked. Everything else is optional.

Top-level

FieldTypeDefaultNotes
keystringRequired. Widget webhook token from the Inviaro admin.
originstringRequired. The page's origin (scheme and domain).
mode'standalone' or 'embed''standalone'Embed renders panel full-pane with no launcher.
themeMode'auto', 'light', 'dark''auto'Auto follows prefers-color-scheme.
position'bottom-right', 'bottom-left', 'bottom-center''bottom-right'Anchors both launcher and panel.
zIndexnumberhigh defaultOverride for hosts with their own high-z stacks.
locale'en', 'bs'auto-detectAuto-detection covers en, bs, hr, sr, me, sh.
hideOnPagesstring array[]Glob patterns of paths where the launcher hides.
hideOnMobilebooleanfalseHide on viewports below 768px.
sessionIdstringautoOverride the generated session id.

Identity and visitor

FieldTypeNotes
userIdstringStable user id from your auth system. Pair with userHash for verification.
userHashstringHMAC-SHA256 of userId, computed server-side. See Identity verification.
userEmailstringVisitor email. Used as fallback when no pre-chat form.
userNamestringVisitor display name.
FieldTypeDefaultNotes
privacyMode'strict', 'balanced', 'fast', 'none''balanced'See Privacy and consent.
consentbooleanundefinedfalse forces memory-only mode and suppresses page-context capture.
noStoragebooleanfalseEquivalent to privacyMode: 'none'.

Brand

ts
brand?: {
  name?: string;
  logoUrl?: string;
  greeting?: string;
  subheading?: string;
  hideFooter?: boolean;
  privacyUrl?: string;
  preChat?: {
    requireName?: boolean;
    requireEmail?: boolean;
    prompt?: string;
  };
}
FieldTypeNotes
brand.namestringWorkspace display name.
brand.logoUrlstringSquare. Renders at 48×48 (36×36 on short mobile). Use SVG, or raster at 96×96 minimum (144×144 for 3× retina). See Theming for details.
brand.greetingstringOverride hero heading. Pass localized text directly.
brand.subheadingstringOverride hero subhead.
brand.hideFooterbooleanSuppress the footer credit.
brand.privacyUrlstringAdds a "Privacy" link next to the footer credit.
brand.preChat.requireNamebooleanForce pre-chat name capture.
brand.preChat.requireEmailbooleanForce pre-chat email capture.
brand.preChat.promptstringOverride the default form prompt.

Data attributes

For environments where embedding an inline <script> block is hard, set the equivalent fields as data-* attributes on the bundle's script tag:

html
<script
  src="https://widget.inviaro.com/v1.js"
  data-key="wt_..."
  data-origin="https://yourdomain.com"
  data-theme-mode="auto"
  data-position="bottom-right"
  async
></script>

window.InviaroSettings always wins when both are present.

Validation

The bundle silently ignores unknown settings. Required fields (key, origin) validate at boot.