Safeguarding settings
When someone says something in a conversation that a person should look at (they may harm themselves, they may be in danger, they report bullying or wrongdoing), Zentiq raises a safety flag and tells your owners, admins and safeguarding contacts by email straight away. Your people read and deal with flags on the console's Safety page.
Safety flags never leave Zentiq: no API, webhook or event carries one, not even its id. The API sets who is told.
Who may change them#
The safeguarding settings need their own scopes, safety:read and safety:write. Only an owner or admin gives them, in the console: choose scopes and tick them when making the key. A key can never give them to another key, full access never includes them, and an app or assistant connected to Zentiq never holds them.
The settings#
GET /v1/safety/settings and PATCH /v1/safety/settings read and change who is told and the facts the avatars' safety words depend on:
| Field | What it is |
|---|---|
country | The emergency and help lines your avatars give, and the age a parent must consent under |
timeZone | The time zone of the dates in safety emails (UTC when unset) |
safeguardingContacts | Up to 10 email addresses told at once about a concern, beside your owners and admins |
privacyNoticeUrl | Your privacy notice, linked where people start a conversation |
PATCH changes only the fields you send, checked as the console checks them; send the whole list of contacts. Each change is recorded in your organization's activity log as made by the key (the contacts' addresses never are, only how many there are).