ReactionCreate

Payload used to create Reaction. Required fields are name, collection_id, condition, actions.

nameName (string)required

alias object

anyOf

• string
• null

string

collection_idCollection Id (string)required

Parent collection ID (required)

Possible values: non-empty

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

description object

anyOf

• string
• null

string

condition objectrequired

When the reaction fires (required)

kindrequired

When the reaction fires (required)

Possible values: [function, ontology, parent, time]

function

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

scheduleSchedule (string)required

Cron expression for evaluation cadence

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

ontology

target_idTarget Id (string)required

EntityType.id or RelationType.id

opOp (string)required

Possible values: [added, modified, removed]

filter object

Optional predicate evaluated against changed row values.

anyOf

• object
• null

object

parent

parent_idParent Id (string)required

Parent Reaction id

time

scheduleSchedule (string)required

Cron expression, e.g. '0 9 * * 1'

actions object[]required

Sequential action chain (required)

Array [

oneOf

• OntologyAction
• FunctionAction
• NotificationAction

on_failure object

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

anyOf

• object
• null

kindrequired

Possible values: [function, notification, ontology]

function

on_failure object

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

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

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

on_failure object

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

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

notification

ontology

ontology

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

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

on_failure object

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

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

on_failure object

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

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

notification

ontology

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

notification

ontology

ontology

kindKind (string)required

Constant value: ontology

target_idTarget Id (string)required

EntityType.id or RelationType.id

opOp (string)required

Possible values: [upsert, delete]

values objectrequired

Row values for upsert / delete key

property name*any

Row values for upsert / delete key

]

ReactionCreate

{
  "name": "string",
  "alias": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "condition": {
    "kind": "ontology",
    "target_id": "string",
    "op": "added",
    "filter": {}
  },
  "actions": [
    {
      "kind": "ontology",
      "target_id": "string",
      "op": "upsert",
      "values": {}
    },
    {
      "on_failure": {
        "kind": "ontology",
        "target_id": "string",
        "op": "upsert",
        "values": {}
      },
      "kind": "function",
      "language": "python",
      "code": "string",
      "params": {}
    },
    {
      "channel": "pipeline",
      "type": "string",
      "collection": "string",
      "resource": "string",
      "message": "string",
      "payload": {},
      "recipients": {
        "users": [
          "string"
        ],
        "groups": [
          "string"
        ],
        "collection": "string",
        "broadcast": false
      },
      "on_failure": {
        "kind": "ontology",
        "target_id": "string",
        "op": "upsert",
        "values": {}
      },
      "kind": "notification"
    }
  ]
}