NotificationPublish

Notification channel, message, payload, and recipients accepted when publishing a notification.

channelChannel (string)required

Possible values: [pipeline, batch, access, system, agent, infra]

typeType (string)required

collection object

anyOf

• string
• null

string

resource object

anyOf

• string
• null

string

messageMessage (string)required

payload object

property name*any

recipients objectrequired

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
• null

string

broadcastBroadcast (boolean)

Whether every active user should receive the notification.

Default value: false

NotificationPublish

{
  "channel": "pipeline",
  "type": "string",
  "collection": "string",
  "resource": "string",
  "message": "string",
  "payload": {},
  "recipients": {
    "users": [
      "string"
    ],
    "groups": [
      "string"
    ],
    "collection": "string",
    "broadcast": false
  }
}