widgets_create
Create a new livechat widget for your website.
The widget will be created with default settings. You can customize theme, auto-reply mode, and more.
Use this when user wants to add a chat widget to their site.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name for the widget (e.g., 'Website Chat', 'Support Widget') | |
| position | No | Widget position on screen | bottom-right |
| allow_voice | No | Master switch for voice — set true to show the mic so visitors can talk to the agent. Everything else voice-related is inert until this is on. The mic also needs a voice-capable agent in the workspace: one with an enabled incoming_call trigger. OMIT to leave voice off (the default). | |
| display_mode | No | Visual mode of the widget. Pick exactly one: - 'chat' (default): full chat panel + voice mic — use for support / sales / general. - 'voice_only': mic-only bubble that launches a voice call directly — pick only when the user explicitly asks for a voice-only widget (e.g. 'just a voice button', 'no chat, just call'). - 'headless': no UI; customer drives via window.DialogBrain JS API — pick only when the user explicitly says 'embed in our own design' / 'no widget chrome'. | chat |
| header_title | No | Title shown in chat header | Chat with us |
| in_workspace | No | Run this one call in this workspace id instead of the session's. Nothing is stored; other sessions are not affected. | |
| primary_color | No | Primary color for widget theme (hex, e.g., '#2563eb') | #2563eb |
| auto_reply_mode | No | Auto-reply mode: 'draft' (review before sending) or 'auto' (send immediately) | draft |
| voice_button_label | No | Localized aria-label and hover tooltip for the voice-only mic bubble (only used when display_mode='voice_only'). ≤ 100 chars. Defaults to 'Talk to agent' if omitted. |