# Omni-channel alerts

Canonical page: https://docs.ovok.com/java-sdk/omnichannel-alerts

Ovok keeps the project's omni-channel alerts rule and runs it on each alert event Signals sends. The rule names who to tell and over which channel, and Ovok tells them by push and email. `ovok.omnichannelAlerts()` reads, sets and previews that rule. It is for project admins, and it needs the `OMNICHANNEL_ALERTS_ENABLED` setting on.

## Set the rule [#set-the-rule]

```java
ovok.projects().settings().update("OMNICHANNEL_ALERTS_ENABLED", true, RequestOptions.defaults());

ovok.omnichannelAlerts().rules().update(Map.of("logic", Map.of("if", List.of(
        Map.of("==", List.of(Map.of("var", "event"), "alert.triggered")),
        Map.of("notify", Map.of("channels", List.of("push", "email"), "to", List.of("practitioner"))),
        List.of()))),
        RequestOptions.defaults());
```

- `logic` is JSON Logic. It answers `notify` entries, each naming `channels` and the roles to tell (`to`), or an empty list to tell nobody.
- The logic can read `event`, `alert.id`, `alert.code`, `alert.reason`, `alert.message`, `alert.value` and `patient.id`.
- `event` is one of `alert.triggered`, `alert.empty`, `alert.note`, `alert.inactive`, `alert.refired`, `alert.resolved` and `alert.acknowledged`.
- Channels are `push` and `email`. Roles are `practitioner`, `caregiver`, `relatedPerson` and `sharedWith`. An unknown label (`UNKNOWN_NOTIFY_LABELS`) or a rule that cannot run on every event (`INVALID_NOTIFICATIONS`) raises an `OvokValidationException`.
- `retrieve` reads the rule under `notifications`, null when the project has none. `remove` deletes it.

## Preview who it reaches [#preview-who-it-reaches]

```java
JsonNode preview = ovok.omnichannelAlerts().preview(
        Map.of("patientId", patientId, "event", "alert.refired"),
        RequestOptions.defaults());
```

- Each entry of `notify` lists the people its roles resolve to for that patient, and whether each has an email address on file.
- `event` is `alert.triggered` when omitted. Add `alert` to set the sample alert's `code`, `reason`, `message` or `value`, and `notifications` to try a rule before you save it. Nothing is sent.

## See also [#see-also]

- [`OmnichannelAlertsResource` reference](/java-sdk/reference/omnichannel-alerts-resource): every method.
- [Push](/java-sdk/push): register devices and set up the push provider.
- [Projects](/java-sdk/projects): project settings.
