VocalDocscontracts 1.65.0

Read a notification rule

GET /v1/notification-rules/{notification_rule_id}

PropertyValue
Operationget_notification_rule
GroupNotification rules
Scopemessages:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a notification rule holds a template over identifiers.
Released in1.60.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the messages:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/notification-rules/ntr_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
notification_rule_idpathNotificationRuleIdyesThe id of a notification rule: ntr_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

StatusContent typeShapeError codes
200application/jsonNotificationRule
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is NotificationRule.

FieldTypeRequiredDescription
connection_idConnectionIdyes
created_atTimestampyes
enabledbooleanyes
event_typesarray of NotificationEventTypeyesThe record event types it delivers (RECORD_EVENT_TYPES).
filterstring or nullyesA ZEN expression over the event envelope; null delivers every event.
fixed_argumentsNotificationArgumentsyesEvery argument but the text, fixed at save, such as the destination channel.
idNotificationRuleIdyes
namestringyes
object"notification_rule"yes
organization_idOrganizationIdyes
revisionintegeryes
templatestringyesThe 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.
toolUpstreamToolNameyesA notify tool of the Connection's Connector.
updated_atTimestampyes