- A Help chat channel in Settings → Channels (admins): what the chat says first, the questions it offers, what you add to the AI's instructions, and the sites that may embed it.
- The AI chat feature in Settings → AI & agents (admins): which provider and model answer. See AI chat for what the AI does, its limits and the transcripts.
While either is off, the chat answers 404, the same as a help center that is off, and no page shows
a chat button. The same happens when the server's operator removes its AI provider or the chat's
model: the help center keeps working without the chat, and the channel in Settings → Channels
says it needs attention because the help center shows no chat.
Where customers chat
The chat page of your help center:
<your help center>/chat(for examplehttps://acme.colliedesk.com/chat, orhttps://desk.example.com/help/acme/chaton a self-hosted server without a help center domain).The chat box of an article: an Ask AI button on every article page opens the chat beside the article, asking about it.
Your own site, with the code from the channel's Your site tab:
<script src="https://acme.colliedesk.com/chat/widget.js" data-channel="<channel id>" async></script>The button shows only on the sites you list under Sites that may embed the chat (exact origins such as
https://shop.example.com, at most 20). It adds no cookie to your site and sends nothing before a visitor presses it. The button takes your help center's brand color (ink without one). Open full chat in the panel moves the chat to your help center's chat page in a new tab; the link it opens works once, for 2 minutes.
Without JavaScript the chat page says so and links to the article search; the articles never need it.
Languages
The chat's own words (its buttons, the box's hint, its notices and the Talk to a person form) are in the language of the page around it, in the languages the help center's own words come in (English, French, German, Spanish, Italian, Portuguese, Brazilian Portuguese, Dutch, Japanese, simplified Chinese, Korean, Vietnamese, Polish, Swedish and Russian; any other in English):
An article's chat box and the Ask AI link: the language of the page. On the pages of a language you show (
/fr/…), the chat is in that language; on your primary language's pages, in your primary language.The chat page: your primary language, or the shown language of its
?lang=(the Ask AI link of a/fr/page adds?lang=fr).Your own site: your primary language. To show the button and the chat in a language you show, add
data-langto the code:<script src="https://acme.colliedesk.com/chat/widget.js" data-channel="<channel id>" data-lang="fr" async></script>A
data-langthat is not a language you show (or one you hid) falls back to your primary language.
Your greeting and suggested questions show as you wrote them. The AI answers in the language of the question, whatever the page's language (AI chat).
Set it up
- Settings → Channels → Add channel → Add help chat.
- Setup: a greeting (at most 300 characters), up to 4 suggested questions (each at most 120), and extra instructions for the AI (at most 2,000; the AI still answers only from published articles, instructions cannot add facts).
- Your site: the sites that may embed the chat, one per line, and the code to copy.
On a help chat that exists, a change to the greeting, the questions, the instructions or the sites waits for Save in the bar at the foot of the page; Discard puts them back.
A workspace may have several help chats, for example one per site; the default one is the help center's chat page. Turn a help chat off with its switch; its settings stay.
Talk to a person
Every chat offers Talk to a person. The customer types an email address (and a name and a note if
they like); a conversation opens in your inbox on the Help chat channel, with the tag help-chat,
the note, and the whole chat as text with the articles it cited. The address was typed, never
checked: the message is marked Unverified sender (Help chat), and the conversation links to its
chat transcript (Open chat transcript next to the label). A second hand-off of the same chat joins
the same conversation. The customer sees a reference they can quote: the first 8 characters of the
conversation's id, the start of its address in Colliedesk (/conversations/<id>), not a search term; the chat goes on after a hand-off.
You reply by email. On a Colliedesk Cloud trial, a reply to a help chat conversation is refused
(error trial_outbound_restricted), as for the web form; the customer is told that you have their
message, not that you will reply by email. One address may hand off 5 chats in 10 minutes, and the
channel opens at most 50 conversations in 10 minutes.
Limits you should know
- Changing the help center's custom domain moves its address: a chat in progress does not continue at the new address.
Was this page helpful?
Updated
This page is rendered from the repository. Spot a mistake? Open an issue or a pull request.