Skip to content

enable GlobalUserId recipients #106

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

Merged
schiwekM merged 4 commits into from
Jan 8, 2026
Merged

enable GlobalUserId recipients #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
663f49a
enable GlobalUserId recipients
Dec 1, 2025
a768662
Update README.md
sleibach Dec 10, 2025
7edba2a
Update README.md
schiwekM Jan 8, 2026
8e49109
Update utils.js
schiwekM Jan 8, 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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ Notifications plugin configures `srv/notification-types.json` as default notific

To make notification types unique to the application, prefix is added to the type key. By default, `application name` is added as the prefix. You can update the `cds.env.requires.notifications.prefix` if required.

### Authentication Identifier

Depending on your Work Zone Notifications configuration, set `cds.env.requires.notifications.authenticationIdentifier` to `UserUUID` if the authenciation identifier in Work Zone is set to `User ID`. Notifications are then published with Recipient Key `GlobalUserId` instead of `RecipientId`. If not set, `RecipientId` is used. Note, that in order for E-Mail Notifications to be sent for notifications published with a User ID, a destination to the IDS needs to be configured for the lookup of the corresponding email address.

For the Work Zone Authentication Identifier configuration details refer to: [Work Zone Subaccount Settings](https://help.sap.com/docs/build-work-zone-standard-edition/sap-build-work-zone-standard-edition/subaccount-settings)

### Low-level Notifications API

You can use these two signature to send the custom notification with pre-defined notification types.
Expand Down
13 changes: 11 additions & 2 deletions lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,15 @@ async function getNotificationDestination() {
return notificationDestination;
}

function getRecipientKey() {
const authenticationIdentifier = cds.env.requires.notifications?.authenticationIdentifier;
var recipientKey = 'RecipientId'; // Email
if (authenticationIdentifier === "UserUUID") {
recipientKey = 'GlobalUserId';
}
return recipientKey;
}

let prefix // be filled in below...
function getPrefix() {
if (!prefix) {
Expand Down Expand Up @@ -160,7 +169,7 @@ function buildDefaultNotification(
NotificationTypeVersion: "1",
Priority: priority,
Properties: properties,
Recipients: recipients.map((recipient) => ({ RecipientId: recipient }))
Recipients: recipients.map((recipient) => ({ [getRecipientKey()]: recipient }))
};
}

Expand All @@ -169,7 +178,7 @@ function buildCustomNotification(_) {

// Properties with simple API variants
NotificationTypeKey: getNotificationTypesKeyWithPrefix(_.NotificationTypeKey || _.type),
Recipients: _.Recipients || _.recipients?.map(id => ({ RecipientId: id })),
Recipients: _.Recipients || _.recipients?.map(id => ({ [getRecipientKey()]: id })),
Priority: _.Priority || _.priority || "NEUTRAL",
Properties: _.Properties || Object.entries(_.data).map(([k,v]) => ({
Key:k, Value:v, Language: "en", Type: typeof v, // IsSensitive: false
Expand Down