NotificationRule
A notification rule (1.60.0; channels.md section 2): an Organization-scoped notify that delivers a templated message about a Vocal event to a fixed destination, through a Connection and one of its notify tools.
An object with 14 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
connection_id | ConnectionId | yes | |
created_at | Timestamp | yes | |
enabled | boolean | yes | |
event_types | array of NotificationEventType | yes | The record event types it delivers (RECORD_EVENT_TYPES). |
filter | string or null | yes | A ZEN expression over the event envelope; null delivers every event. |
fixed_arguments | NotificationArguments | yes | Every argument but the text, fixed at save, such as the destination channel. |
id | NotificationRuleId | yes | |
name | string | yes | |
object | "notification_rule" | yes | |
organization_id | OrganizationId | yes | |
revision | integer | yes | |
template | string | yes | The text in the closed template language of prompt-manager.md section 3, over the event envelope's fields; in PHI mode the envelope carries identifiers only. |
tool | UpstreamToolName | yes | A notify tool of the Connection's Connector. |
updated_at | Timestamp | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.