The help widget puts a “Help” button on your customer’s website or web application. Its visitors search the knowledge base for an answer and write to you without leaving the page. The widget follows the same rules as the external portal. This article is for the help desk administrator and for agents.
Before you start #
- You need the Administer the help center right (Execute level; Access to read the settings).
- The widget shows the knowledge base’s external articles and the services open to external people, like the portal (see External portal and incoming e-mail). With no external service and no external article, the settings page warns that the widget has nothing to show.
- You need the list of domains where the widget will appear (for example www.lumen-optique.ch), and someone who can edit the website.
Setting up the widget #
Open Settings › Help center › Help widget.

- In Authorised domains, enter one domain per line. *.acme.ch covers all subdomains, but not acme.ch itself: add both if needed.
- Choose the look: the button’s Colour, its Position (Bottom right or Bottom left) and the panel’s Language (The visitor’s, or a fixed language). The Button preview shows the result; the text stays readable on a light colour.
- Turn on Show the widget on the authorised domains, then click Save. Without a domain, the widget cannot be turned on.
Putting the widget on the website #
At the top of the page, Code to paste on the website gives one line to copy (copy button). The person who manages the website pastes it just before the end of each page where the button should appear. Two optional settings go on that line:
data-languefixes the panel’s language on that page (fr, en, de or it);data-clientattaches the identifier of the customer signed in to the website to the ticket, for example their customer number.
The website can also open or close the panel from its own code, for example from its own “Contact” link.
What the visitor sees #

A click on Help opens the How can we help you? panel:
- the knowledge base search (Search for an answer…) and the Most read articles; an article opens in the panel;
- Didn’t find your answer? then Contact support opens the request form;
- My requests opens the portal, where the person follows their requests;
- during an outage of a service open to external people, the ongoing incident’s message, with I am affected: the form opens prefilled, and the request will follow the incident (see Major incidents and problems).

The form asks for the e-mail address and name, the service (if there are several) and the request type (with the type’s fields), the subject, the description and any attachments. While the subject is being typed, articles that may answer the question are suggested. After Send:
- the request is registered and an acknowledgement goes to the address given, with a link to follow it;
- or, if the service requires the address to be confirmed, a confirmation link is sent first: the request is created when it is clicked.
The panel follows the chosen language (French, English, German or Italian) and the dark mode of the visitor’s device. The website’s styles do not change it.
The ticket on the agent’s side #

A request filed through the widget arrives on the Website widget channel. The ticket page shows what the website sent: the page the request came from (link), its title, and the customer identifier marked declared by the website.
- This information comes from the website and is never verified: use it as a clue, not as proof of identity.
- Only agents see it; the requester does not. The page is sent without its parameters.
- Reporting and the tickets report count the Website widget channel separately.
Good to know #
- Outside the authorised domains, the button does not appear, and the browser refuses to show the panel even if someone copies the code elsewhere. A request sent from another website is refused.
- Turning the widget off removes it from every website, without touching the pasted code: it comes back as soon as you turn it on again.
- The portal’s rules apply here too: services and types open to external people, address confirmation, attachments (at most 5 files, 10 MB each), and a limited number of requests per address and per website.
- When a person is linked to a client organisation, their widget requests are too (see Client organisations).
- Anonymising a ticket also erases what the website sent. Setting changes are recorded in the help desk log.
