Skip to main content

NotificationRecipients

Notification recipient predicates. Users, groups, collection readers, and broadcast recipients are combined and deduplicated. A request with no predicates is rejected with 422; a valid predicate that resolves to no users creates zero deliveries.

usersstring[]

User identifiers that should receive the notification directly.

groupsstring[]

Group identifiers whose members should receive the notification.

collection object

Collection whose readers should receive the notification.

anyOf
string
broadcastBroadcast (boolean)

Whether every active user should receive the notification.

Default value: false
NotificationRecipients
{
"users": [
"string"
],
"groups": [
"string"
],
"collection": "string",
"broadcast": false
}