NotificationAction

Shared request and response schema. Request: Notification action accepted when configuring a reaction, including its recipients, message, and channel. Response: Notification action returned for a reaction, including its recipients, message, and channel.

channelChannel (string)필수

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

typeType (string)필수

collection object

하나 이상(anyOf)

• string
• null

string

resource object

하나 이상(anyOf)

• string
• null

string

messageMessage (string)필수

payload object

property name*any

recipients object필수

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.

기본값: false

each object

A list path in the payload the body repeats over — context.rows for an ontology condition, context.parameters.<name> for an Action's many row parameter

하나 이상(anyOf)

• string
• null

string

on_failure object

Compensating action, run when this action raises. 1-depth only.

하나 이상(anyOf)

• object
• null

object

One chain action of the same kinds, selected by kind (ontology, dataset, function, or notification). A fallback action cannot have its own on_failure.

kindKind (string)필수

상수 값: notification

NotificationAction

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