Appearance
Settings
Complete reference for window.InviaroSettings. Required fields are marked. Everything else is optional.
Top-level
| Field | Type | Default | Notes |
|---|---|---|---|
key | string | Required. Widget webhook token from the Inviaro admin. | |
origin | string | Required. 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. |
zIndex | number | high default | Override for hosts with their own high-z stacks. |
locale | 'en', 'bs' | auto-detect | Auto-detection covers en, bs, hr, sr, me, sh. |
hideOnPages | string array | [] | Glob patterns of paths where the launcher hides. |
hideOnMobile | boolean | false | Hide on viewports below 768px. |
sessionId | string | auto | Override the generated session id. |
Identity and visitor
| Field | Type | Notes |
|---|---|---|
userId | string | Stable user id from your auth system. Pair with userHash for verification. |
userHash | string | HMAC-SHA256 of userId, computed server-side. See Identity verification. |
userEmail | string | Visitor email. Used as fallback when no pre-chat form. |
userName | string | Visitor display name. |
Privacy and consent
| Field | Type | Default | Notes |
|---|---|---|---|
privacyMode | 'strict', 'balanced', 'fast', 'none' | 'balanced' | See Privacy and consent. |
consent | boolean | undefined | false forces memory-only mode and suppresses page-context capture. |
noStorage | boolean | false | Equivalent 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;
};
}| Field | Type | Notes |
|---|---|---|
brand.name | string | Workspace display name. |
brand.logoUrl | string | Square. 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.greeting | string | Override hero heading. Pass localized text directly. |
brand.subheading | string | Override hero subhead. |
brand.hideFooter | boolean | Suppress the footer credit. |
brand.privacyUrl | string | Adds a "Privacy" link next to the footer credit. |
brand.preChat.requireName | boolean | Force pre-chat name capture. |
brand.preChat.requireEmail | boolean | Force pre-chat email capture. |
brand.preChat.prompt | string | Override 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.