Omni-channel alerts

Get the project's omni-channel alerts rule

  • Sandbox: available
  • On your own host? Choose https://{host} in the playground.
GET
/v1/omnichannel-alerts/rules

Returns your project's omni-channel alerts rule: the JSON Logic Ovok runs on each alert event Signals sends, to choose who it tells and over which channels.

Scope: the caller's project (from the token).

Behaviour

  • notifications is { logic }, or null when the project has no rule and nobody is told.
  • Ovok keeps the rule with your project. Signals is not involved.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/omnichannel-alerts/rules' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Who can call it: a project admin. See roles.

Authorization

bearer
headerAuthorizationBearer <JWT>

Response Body

The rule, or null when the project has none.

application/json
  1. response
notifications*

The rule Ovok runs for the project, or null when it has none and nobody is told.

Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/omnichannel-alerts/rules'
Example Response
{  "notifications": {    "property1": null,    "property2": null  }}

Give or withdraw the medical consent POST

Gives or withdraws the medical settings notifications consent for the signed-in practitioner and returns the resulting medical consent. Other consents are not changed. **Auth:** The profile must be a `Practitioner`. The caller's access policy must grant `Consent:read`, `Consent:search`, `Consent:create` and `Consent:update` (a project admin who holds no access policy skips this check). **Scope:** The caller's practitioner profile in the caller's project (from the token). ## Behaviour - `medicalSettingsNotificationsConsent: true` records the consent on the currently published version. `false` withdraws it. - Sending the current value again writes nothing. - The value read by `GET /v1/slim/user/consents` changes in the same commit. - The response has the shape of `GET /v1/me/consent/medical`: `medical` is `null` after a withdrawal. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/me/consent/medical' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "medicalSettingsNotificationsConsent": true }' ``` **Who can call it:** a practitioner, a project admin or a System Owner session. See [roles](/access-policies#who-can-call-a-route).

Remove the project's omni-channel alerts rule DELETE

Removes your project's omni-channel alerts rule. From then on Ovok tells nobody of alert events, even with the setting on. **Scope:** the caller's project (from the token). ## Example ```bash curl -X DELETE 'https://api.sandbox.ovok.com/v1/omnichannel-alerts/rules' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ``` **Who can call it:** a project admin. See [roles](/access-policies#who-can-call-a-route).