Documentation / Set-up guides / Channels
Website Chat
On this page
On this page
This guide is for
A chat window on your own website. A visitor writes in their own language, and the conversation arrives in Inbox as a website chat.
What it needs
- The Website Chat module switched on in Admin → Apps. It needs CRM and Mail, and a connected mailbox.
- For each website: its exact HTTPS address, with no wildcard and no path; the address of your privacy policy; and the brand name the window shows. One installation takes up to ten addresses.
Installing it
- Open Admin → Apps → Website Chat → Settings. It opens the installation guide for this workspace: how an installation is registered and switched on. A new installation starts disabled, and AI replies are switched on for each installation and use the workspace's credits.
- Put the line below on every page that should show the chat, with your desk's address in place of YOUR-DESK and the installation's ID in place of INSTALLATION-ID.
<script defer src="https://YOUR-DESK/chat/widget.js" data-site="INSTALLATION-ID"></script>- The installation's ID is a public identifier, not a password: it is safe in the page's source.
- If your website sends a Content-Security-Policy, allow the desk's address in script-src and connect-src.
- A reply written in Inbox to a visitor who left an email address goes to that address by email. It does not appear in the chat window.
- Hosted installation setup uses the administrator API linked from Settings. Register your own brand, label, privacy URL, allowed addresses and an auto agent name; explicitly enable the installation. The operator must route /chat/* on the workspace’s public address before an external website can use the widget.
- Hosted uploads allow 48 KiB per file, five files per message and 256 KiB across ten uploads per conversation. Attachment contents are not read automatically. The chat admits at most 100 messages and 64 KiB of message text.
- Hosted staff takeover through the chat API sends to the same widget and pauses AI replies. The ordinary Inbox email composer still sends a separate email; there is no dedicated takeover button in Inbox yet.
A chat window on your own website. A visitor writes in their own language, and the conversation arrives in Inbox as a website chat.
What it needs
- The Website Chat module switched on in Admin → Apps. It needs CRM and Mail, and a connected mailbox.
- For each website: its exact HTTPS address, with no wildcard and no path; the address of your privacy policy; and the brand name the window shows. One installation takes up to ten addresses.
Installing it
- Have the installation registered. There is no screen for this yet: a developer registers it through the desk's admin API at /api/plugins/website-chat/sites, with the brand, the website's addresses, the privacy policy's address and the languages offered. The answer carries the installation's ID.
- Put the line below on every page that should show the chat, with your desk's address in place of YOUR-DESK and the installation's ID in place of INSTALLATION-ID.
<script defer src="https://YOUR-DESK/chat/widget.js" data-site="INSTALLATION-ID"></script>- The installation's ID is a public identifier, not a password: it is safe in the page's source.
- If your website sends a Content-Security-Policy, allow the desk's address in script-src and connect-src.
- A reply written in Inbox to a visitor who left an email address goes to that address by email. It does not appear in the chat window.