Settings

OMNICHANNEL_ALERTS_ENABLED

Turns on Omni-channel alerts, so Ovok runs your rule on each Signals alert event and tells the people it names.

Turns on Omni-channel alerts. Ovok runs your rule on each alert event Signals sends and tells the people it names, by push and email.

TypeBoolean setting
Change withPUT /v1/project/settings/OMNICHANNEL_ALERTS_ENABLED
Who can change itProject admin
When unsetOff
NeedsA Signals tenant of the project's own
When offOvok tells nobody. Signals still sends its alert events to your own webhooks.
curl -X PUT 'https://api.sandbox.ovok.com/v1/project/settings/OMNICHANNEL_ALERTS_ENABLED' \
  --header "Authorization: Bearer ${OVOK_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"enabled": true}'

What turning it on does

Ovok subscribes to the tenant's alert events. Turning it off removes the subscription.

The setting does not write a rule. Until you save one, nobody is told.

Gotchas

  • No rule, no messages. Check GET /v1/omnichannel-alerts/rules after turning it on.
  • Map the email templates. ALERT_NOTIFICATION and PATIENT_ALERT_NOTIFICATION go out through your email templates.
  • Shared Signals tenants are not supported. The project needs a tenant of its own.

Last updated on

On this page