Update the web chat
update_web_chatChange what visitors of the customer's website see in the chat: on/off, title, greeting, agent name, subtitle, colours, logo, pre-chat form, email alerts, conversation starters, satisfaction rating, live-visitor tracking, quick links, AI-notice and privacy links, and placement. Only the fields you pass change. Changes go live on the website at once: show the user what will change and confirm first. Allowed domains and the widget key can only be changed by a person in the Ignix app.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csat | No | Ask visitors π/π whether the chat helped; the rating shows in the inbox. | |
| look | No | Visual style: "classic" (coloured header) or "glass" (translucent panel with the logo as a cover, quick links on top and the AI-notice/privacy links at the foot). | |
| title | No | Header title (max 60 characters). | |
| enabled | No | Turn the chat on or off on the website. | |
| logoUrl | No | Public http(s) URL of the logo; "" removes it. | |
| offsetX | No | Distance from that side, in pixels (0-200). Raise this to clear a fixed sidebar. | |
| offsetY | No | Distance from the bottom, in pixels (0-200). Raise this to sit above a sticky bar instead of moving to the other corner. | |
| preChat | No | Ask the visitor for their name before chatting. | |
| greeting | No | First message the visitor sees (max 500 characters). "" removes it. | |
| position | No | Which side the bubble sticks to. | |
| starters | No | Conversation starters shown as buttons (max 6, 80 characters each). Replaces the list; [] clears it. | |
| subtitle | No | Line under the title, e.g. "We reply in minutes" (max 80 characters). | |
| agentName | No | Name the assistant signs with (max 60 characters). "" removes it. | |
| hidePaths | No | Paths where the bubble must not appear (max 20). "*" matches anything after it, e.g. "/checkout*". Pass an empty array to clear. | |
| textColor | No | Text colour on the accent, hex; "" = automatic by contrast. | |
| panelColor | No | Panel background for the glass look, hex; "" = automatic. | |
| privacyUrl | No | http(s) link to the privacy policy; "" removes it. | |
| quickLinks | No | Action buttons of the glass look, max 3: [{"label":"Book","url":"https://β¦"}] (label max 24 characters). Replaces the list; [] clears it. | |
| themeColor | No | Accent colour, hex like #FF6A00. | |
| aiNoticeUrl | No | http(s) link to the page explaining the AI assistant; "" removes it. | |
| collapsible | No | Let visitors fold the bubble into a tab at the edge. It does not close the chat: it comes back on the next page, and reopens on its own if someone replies. | |
| notifyEmail | No | Email that gets an alert when a visitor writes; "" stops the alerts. | |
| workspaceId | No | Defaults to the workspace this connection is scoped to. | |
| hideOnMobile | No | Do not load the chat at all on screens under 640px. | |
| liveVisitors | No | Track who is browsing the site right now (page path and an anonymous id only) for the Live visitors page. | |
| preChatEmail | No | Also ask for their email in that form (needs preChat). | |
| customLauncher | No | Hide our bubble entirely; the site opens the chat by calling Ignix.open() from its own button. | |
| idempotencyKey | No | Optional. A unique id for this action (16-128 chars: letters, digits, _ : . -). If you are unsure whether a call went through (timeout, network error), repeat it with the SAME idempotencyKey and the same arguments: you get the original result and nothing is done twice. |