System and maintenance

Notification administration — what went out, and tuning events

Administrators with Alert Settings permission can see every notification the system tried to send — to whom, how, and whether it arrived — and can tune each event: its wording, who hears about it by default, and which channels it uses. This is done through the notification administration endpoints (/api/notifications/admin/…); a dedicated screen follows in a later update.

Before you start

  • Your user group must have Alert Settings.
  • Changing an event's defaults affects new notifications only, and only for people who have not set their own preference for that event.

What you can do

See what went out

GET /api/notifications/admin/outbox lists recent events (newest first) with counts of deliveries sent / failed / skipped. …/outbox/{id}/deliveries lists each person and channel with the reason for any skip:

Reason Meaning
not-default That channel is not a default for the event and the person did not turn it on.
preference The person switched that channel off for this event.
push-off The person paused push on all their devices.
quiet-hours Deferred until the person's quiet hours end (row stays Pending).
digest Held for the person's summary email.
no-device / no-email / no-phone Nowhere to send on that channel.
not-configured / offline The channel is not set up on this server, or the server cannot reach the internet.
no-audience Nobody matched the event's audience rule.

POST …/outbox/{id}/retry puts a failed event or its failed deliveries back in the queue.

Tune an event

GET /api/notifications/admin/event-types shows every event with its wording, default channels and audience rule. PUT …/event-types/{code} changes any of:

  • Name / description — what people see in their preferences.
  • Title / body / link templates — use {{Placeholder}} names exactly as they appear in the current templates; an unknown name renders blank.
  • Default channels — any of InApp, WebPush, Email, Sms, WhatsApp.
  • Audience rule — who hears about it by default, for example {"any":[{"kind":"permission","code":"PAYMENT_RECEIPT"}]} or {"any":[{"kind":"administrators"}]}.
  • Priority — 3 means urgent (ignores quiet hours and summaries).
  • Active — switch an event off entirely.

An edited event is marked customized and keeps your changes through upgrades. {"resetToDefault": true} returns it to the product's defaults.

Tips

  • Switch off events your business does not use (for example keycards in a shop) so the preferences page stays short.
  • Before changing an audience rule, check who it reaches today: the deliveries list of a recent event shows exactly that.

Common problems

  • Nothing is being delivered to anyone → look at the outbox: Skipped — no-audience means the rule matches no active user; Failed rows carry the provider's own error text.
  • Email shows not-configured → the server's email service is not set up; the bell still works.
  • A person says they never get an event → open a recent delivery list for that event and find their row; the skip reason explains it.

See it working on your own business

Start a 45-day free trial — no card needed — and follow this guide in your own practice company.