Configuration

Every widget configuration option — workspace, region, theming, launcher, and more.

You configure a widget either by assigning window.SupportChatSettings before the loader runs (the Quickstart snippet does exactly this) or by passing the same options to SupportChat.createChat(...):

// Option 1 — set settings, let the loader auto‑boot:
window.SupportChatSettings = {
  workspaceId: "{YOUR_WORKSPACE_ID}",
  widgetId: "{YOUR_WIDGET_ID}",
};
 
// Option 2 — create an instance programmatically:
const chat = SupportChat.createChat({
  workspaceId: "{YOUR_WORKSPACE_ID}",
  widgetId: "{YOUR_WIDGET_ID}",
});

Option	Type	Default	Description
`workspaceId`	`string`	—	Required. Your workspace id (`ws_…`).
`widgetId`	`string`	—	Widget id (`wgt_…`). Optional only if the workspace has a default widget.
`region`	`"us" \| "eu" \| "au" \| "custom"`	`"us"`	Data‑residency endpoints.
`apiBase`	`string`	region default	API base URL (for `custom`/self‑host).
`widgetBase`	`string`	region default	Hosted widget UI base URL.
`autoBoot`	`boolean`	`true`	Auto‑boot an anonymous session on load.
`autorender`	`boolean`	`true`	Mount the floating widget automatically.
`locale`	`string`	workspace default	BCP‑47 locale, e.g. `"en-US"`.
`theme`	`ThemeConfig`	workspace default	Initial theme overrides.
`launcher`	`LauncherConfig`	workspace default	Launcher position/label/badge.
`privacy`	`PrivacyConfig`	`{}`	Initial cookie‑consent level.
`debug`	`boolean`	`false`	Verbose console diagnostics.

These options are read once when the session is created; network work happens on boot(). Ongoing changes are made with the runtime methods documented below (for example update() and setTheme()).