Read the web chat settings
get_web_chatRead the web chat bubble the customer embeds on their own website: whether it is on, title, greeting, agent name, colours, logo, pre-chat form, alert email, starters, quick links and AI/privacy links, its placement (side, offsets, hidden paths, mobile), the allowedDomains, and the snippet (one script tag) to paste once into the site. Use it before changing anything: update_web_chat changes what visitors see and set_web_chat_placement only moves or hides the bubble. Each workspace has one chat. If it does not exist yet, exists is false and you get the defaults with no snippet: nothing is created by reading; the first update_web_chat or set_web_chat_placement creates it. Allowed domains and the widget key can only be changed by a person in Ignix → Sparky → Web chat.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | No | Workspace whose web chat to read (an id from list_workspaces). Defaults to the workspace this connection is scoped to. |