Skip to content

Update notifications plugin #2851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lisajulia wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update notifications plugin #2851

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26af6b2
Update link to notifications plugin: add alpha label for Java
lisajulia Sep 2, 2026
10006b8
Update features for notifications plugin
lisajulia Sep 2, 2026
03c9c8c
Merge branch 'main' into feat/update-notifications-plugin
lisajulia Sep 2, 2026
587ea13
Merge branch 'main' into feat/update-notifications-plugin
lisajulia Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions plugins/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ Available for:
## Notifications


The Notifications plugin provides support for publishing business notifications in SAP Build Work Zone. Notification types are defined by annotating CDS events, which the plugin then intercepts and forwards automatically:
The Notifications plugin provides support for sending emails and publishing business notifications in SAP Build Work Zone. Define notification types declaratively via `@notification` CDS annotations or JSON config — the plugin intercepts annotated events and forwards them automatically:

```cds
@notification: {
Expand Down Expand Up @@ -382,22 +382,23 @@ service IncidentService {
Features:

- CAP service-based API — simple, backend-agnostic
- Notification types defined via CDS @notification annotations
- Notification types defined via JSON (Node.js only)
- Notification types defined via CDS `@notification` annotations — `cds build` compiles them to `notification-types.json`
- Notification types defined via JSON config
- Auto-emit: annotated CDS events are forwarded to ANS automatically
- Email delivery via configurable delivery channels
- **Email delivery** via `@notification.email.subject` and `@notification.email.html` annotations with Mustache syntax
- Email HTML templates for rich email notifications
- Batch notifications — emit multiple notifications in a single call
- i18n support and dynamic priority for notification types
- **Batch notifications** — send multiple notifications in a single outbox event
- **i18n support** via `{i18n>key}` syntax in annotations
- **Dynamic priority** via `@notification.priority` with runtime expressions
- Console logging in development — no external service needed
- Transactional outbox — maximized scalability and resilience
- Automatic registration and lifecycle management of notification types on startup

- Optional database storage for sent notifications with cooldown to prevent duplicate delivery (Java)

Available for:

[![Node.js](/logos/nodejs.svg 'Link to the plugins repository.'){style="height:2.5em; display:inline; margin:0 0.2em;"}](https://github.com/cap-js/notifications#readme)
[![Java](/logos/java.svg 'Link to the plugins repository.'){style="height:3em; display:inline; margin:0 0.2em;"}](https://github.com/cap-java/cds-feature-notifications#readme)
[![Java](/logos/java.svg 'Link to the plugins repository.'){style="height:3em; display:inline; margin:0 0.2em;"}](https://github.com/cap-java/cds-feature-notifications#readme) <Alpha />


## Telemetry
Expand Down
Loading