User
Inbox Live Chat Widget
Screen guide
Before you start
Use the account and workspace that own the relevant records. The feature also needs to be enabled for this installation and plan.
Open this feature
- Open /portal/inbox/live-chat-widget on your site.
Steps
Choose a task
Use Create widget
- Open /portal/inbox/live-chat-widget on your application domain, using the workspace account for this task.
- Select the intended record or item first and review its displayed values. There is no separate input form described for this control.
- Select Create widget. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
Use Save changes
- Open /portal/inbox/live-chat-widget on your application domain, using the workspace account for this task.
- Find the form containing Launcher label, Position, Accent color. Complete the relevant fields using the table below. Fields can appear or change after you select an option.
- Select Save changes. Check the current record, recipients, amount or destination before confirming when those values apply.
- If the application identifies a missing or invalid field, correct that field and submit again. If an external request or payment has an uncertain outcome, check its history before repeating it.
| Field | What to enter or choose |
|---|---|
| Launcher label | Required. Enter the launcher label for this task, using the help or example shown by the form. Maximum 50 characters. |
| Position | Required. Choose Bottom right, Bottom left. |
| Accent color | Required. Enter the accent color for this task, using the help or example shown by the form. |
| Panel title | Required. Enter the panel title for this task, using the help or example shown by the form. Maximum 80 characters. |
| Open animation | Required. Enter the open animation for this task, using the help or example shown by the form. |
| Widget font | Required. Enter the widget font for this task, using the help or example shown by the form. |
| Welcome message | Required. Enter the welcome message for this task, using the help or example shown by the form. Maximum 280 characters. |
| Composer placeholder | Required. Enter the composer placeholder for this task, using the help or example shown by the form. Maximum 120 characters. |
| Require visitor name | Enter the require visitor name for this task, using the help or example shown by the form. |
| Require visitor email | Enter the require visitor email for this task, using the help or example shown by the form. |
| Assistant name | Required. Enter the assistant name for this task, using the help or example shown by the form. Maximum 80 characters. |
| Minimum confidence | Required. Choose High - stricter threshold, Medium - more answers. |
| Reply tone | Required. Enter the reply tone for this task, using the help or example shown by the form. Maximum 40 characters. |
| Reply language | Required. Enter the reply language for this task, using the help or example shown by the form. Maximum 40 characters. |
| AI reply limit per conversation | Required. Enter a number in the unit shown by this setting. Check any currency, duration or count label before saving. Minimum 1. Maximum 20. |
| Only answer from approved Knowledge Base | Enter the only answer from approved knowledge base for this task, using the help or example shown by the form. |
| Handoff message | Required. Enter the handoff message for this task, using the help or example shown by the form. Maximum 500 characters. |
| Human handoff keywords | Optional unless the current form requests it. Enter the human handoff keywords for this task, using the help or example shown by the form. Comma-separated. These always transfer the conversation to your team. Maximum 1000 characters. |
| Routing mode | Required. Enter the routing mode for this task, using the help or example shown by the form. |
| Picker title | Required. Enter the picker title for this task, using the help or example shown by the form. Maximum 120 characters. |
| Required | Enter the required for this task, using the help or example shown by the form. |
| Widget name | Required. Enter the widget name for this task, using the help or example shown by the form. Maximum 255 characters. |
| Website URL | Optional unless the current form requests it. Enter the complete address required by this field. For a callback or webhook, copy the URL shown by the running application instead of guessing its path. Maximum 500 characters. |
Fields and choices
Field descriptions appear beside each task above so that separate forms are not mixed together.
Check the result
- Stay in the same account/workspace and reopen the intended record or result screen.
- For saved settings, compare the displayed values with the choices you made. For filters and previews, check the current result scope.
- For queued or external work, inspect its status/history and provider result where applicable. A successful save does not by itself prove message delivery, publication, payment completion or provider approval.
Common problems
| Problem | What to check |
|---|---|
| The screen or action is missing | Check the correct workspace account, role, enabled app and plan. A hidden action is not fixed by typing an internal endpoint. |
| A field is rejected | Read its validation message, choose from the offered options and check the relevant format or limit. Do not substitute a database ID for a displayed choice. |
| A list is empty | Check the selected workspace, search text, date range and status filters. Clear one filter at a time before concluding that records are missing. |
| A request is still pending | Check its status/history before repeating it. For messages, publishing, imports and payments, a submitted request can finish later or fail separately. |
Technical reference
Role-scoped source references
Pinned commit: 68a5655db1bbe17c74fb211f0fe0ee4e63c8be88
- modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php
- modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetTestController.php
- modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php
- modules/Inbox/InboxLiveChatWidget/resources/views/livewire/studio-styles.blade.php
- modules/Inbox/InboxLiveChatWidget/resources/views/livewire/workspace.blade.php
- modules/Inbox/InboxLiveChatWidget/resources/views/public/widget-script.blade.php
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /portal/inbox/live-chat-widget |
| GET | /portal/inbox/live-chat-widget/{widgetId}/test |
| GET | /portal/inbox/live-chat-widget/{widgetId} |
| GET | /integrations/live-chat/widget/{token}.js |
| GET | /integrations/live-chat/widget/{token}/bootstrap |
| GET | /integrations/live-chat/widget/{token}/messages |
| POST | /integrations/live-chat/widget/{token}/messages |
| POST | /integrations/live-chat/widget/{token}/typing |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| launcherIcon | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| launcherStyle | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| launcherImageUrl | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| headerPattern | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| accentColor | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| allowedDomainsText | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| conversationMode | modules/Inbox/InboxLiveChatWidget/Livewire/LiveChatWidgetWorkspace.php |
| session_id | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| name | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php | |
| routing | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| after_id | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| body | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| page_url | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| preferred_user_id | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| attachment | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |
| active | modules/Inbox/InboxLiveChatWidget/Http/Controllers/LiveChatWidgetPublicController.php |