Skip to content

Products ​

A product is one thing your users report from: an app, a game, a device. Each has its own keys, users, reports, settings and look, and nothing is shared between products. Admin → Products lists them, with where each is kept: this page, or the config file on a self-hosted deployment.

Add product makes one. Every setting has a default, so an id and a name are enough to start. Changes are saved with Save changes, which counts what's unsaved. Delete product asks you to type its id.

A product from the configuration file is read-only here (This product is the config file's: change it there). Its webhooks can still be managed on the page.

The settings ​

SectionWhat it sets
Generalthe id (it can't change later), the name, an optional support role whose holders work this product's desk, the privacy page shown to users, and the web origins allowed to use its keys from a browser
Brandinga colour, an accent and a logo, shown to users in the clients
Contactwhether users may leave a contact at all (Off or Optional), what kind (an email address, or something else such as a forum name), and what the user agrees to: the consent text shown to them in full
Conversationswhether new tickets are tickets or live conversations, who may take one live (nobody, support, the user asking, or either), and after how many quiet minutes it goes back to a ticket. See Live conversations
Keepingafter how many days resolved or closed reports are deleted, and users not seen
Limitsper hour: reports and comments per user and per address, and the like. Empty is the default. A key in quarantine gets a twentieth of each
Context fieldswhat a report may carry beside the note: a name, a label and a type (text, number, yes/no, a place, a link built from other fields, JSON). Anything a product sends that isn't declared is dropped
Telemetryan optional JSON Schema the telemetry must match, and its size at most. A report that doesn't match is refused, with the reason
Redactionthe rules applied to the telemetry, the context and the note, on the device and again on the server
Removablewhich telemetry or context values the user may take out before sending
Attachmentshow many files, how large together, and which types, including types of your own
Remote assistancewhat support may ask for (a shell, the screen), how long a session lasts, and how long the device has to answer. See Remote assistance
Webhooksthe endpoints that get this product's ticket events. See Webhooks

The clients fetch these settings from the service, so a change here reaches your users without a new build.

Redaction ​

Each rule has a path (such as /telemetry/account or /note), a strategy and its setting:

StrategyDoes
dropremoves the value
maskshows •••• and the last few characters
truncatekeeps the first so many characters
roundrounds a number to a step
coarsenlowers the precision of a number or a place
regexreplaces whatever matches a pattern, such as email addresses
hasha pseudonym: support can see that two reports share it, never what it is

Try it runs the rules on a sample report, as a build would send it, and shows exactly what support would see. Try a rule before you save it.

The product editor's redaction rules: hash an account, mask a licence, replace email addresses in the note; a sample report on the left and what support sees on the rightDemo data.