Skip to content
Docs menu

Support chat widget and help center

Put a chat on your own site that opens conversations in the Support inbox, answer them live, and publish a help center from your published Notes pages. Served from your own cloud, with no third-party script, font or analytics.

View .md

The chat widget is a round button on your site. A visitor types a message; it becomes a conversation on the channel chat in the Support inbox. Your replies show up in the widget within a few seconds. If you turn on the help center, the widget also searches your help articles first and asks "Did this answer your question?".

Everything is served from your own Venom Cloud. The widget loads no third-party script, font or analytics and calls no other host.

Turn it on

Support settings, "Chat widget and help center" (owners and admins):

  1. Add the sites that may show it, one https origin per line (https://example.com; http://localhost:3000 works for development). A site that is not listed cannot frame the widget at all: the page's frame-ancestors policy lists exactly these origins.
  2. Switch the widget on and choose a title, greeting and colour. "Ask visitors for an email" shows an optional email field before the first message.
  3. Copy the snippet into your site:
<script src="https://YOUR-CLOUD/w/embed.js" data-key="vsw_…" data-accent="#2563eb" defer></script>

data-position="left" moves the button to the left. VenomChat.open() and VenomChat.close() open and close the chat from your own code. "New key" makes a new public key and ends the old snippet.

Answering

A visitor's first message opens a conversation tagged chat, with the first line as its subject. Their next messages join it. If you close it and the visitor writes again within 14 days, it reopens; later they start a new one. Answer with the normal reply box or support_reply_send: on a chat conversation nothing goes through an email provider, the reply is shown in the widget. Internal notes and AI drafts are never shown to the visitor. If the visitor gave an email, it becomes the customer's address (an existing customer with that address takes over the conversation).

SLA policies, assignment, tags and the reports work on chat conversations like on any other.

Abuse protection

Defences are local, like Forms:

  • A new visitor solves a small proof of work (about a second, in their browser) to start a session; each solved challenge works once and expires after 10 minutes.
  • The visitor is a signed anonymous token kept in the frame's own storage; it names no person.
  • Rate limits per IP (a keyed hash that changes daily), per visitor and per widget. Messages are at most 4,000 characters.
  • Only listed origins can frame the widget.

Help center

Switch on "Public help center" and name a Notes folder in your shared vault (default Help/). The help center shows pages that are all of:

  • published in Notes (Share, Publish to web), and
  • in the org's shared vault (never a person's or a team's vault), and
  • under that folder.

Nothing else is reachable. It lives at /help/<key> (searchable, grouped by subfolder), each article at /help/<key>/<page id> (route /help/{key}/{id}), and the text is reduced like any published page: wikilinks become plain words, embeds and databases are dropped, links into the app lose their address. Unpublishing a page, moving it out of the folder or turning the help center off removes it at once. The pages are not indexed by search engines.

For agents

Tool REST Does
support_widget_get GET /support/widget Settings, public key and the embed snippet
support_widget_save PATCH /support/widget Change them (enabled, origins, title, greeting, accent, ask_email, help_enabled, help_prefix, rotate_key); owners and admins
support_help_article_list GET /support/help-articles The pages the help center shows now; query searches them