Read a notification rule
GET /v1/notification-rules/{notification_rule_id}
Property Value Operation get_notification_ruleGroup Notification rules Scope messages:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; a notification rule holds a template over identifiers. Released in 1.60.0 Phase 0 host Served (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 Node.js Python
curl "$VOCAL_API/v1/notification-rules/ntr_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/notification-rules/ntr_...`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/notification-rules/ntr_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)
Parameters
Name In Type Required Description notification_rule_idpath NotificationRuleId yes The id of a notification rule: ntr_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is NotificationRule .
Field Type Required Description connection_idConnectionId yes created_atTimestamp yes enabledboolean yes event_typesarray of NotificationEventType yes The record event types it delivers (RECORD_EVENT_TYPES). filterstring or null yes A ZEN expression over the event envelope; null delivers every event. fixed_argumentsNotificationArguments yes Every argument but the text, fixed at save, such as the destination channel. idNotificationRuleId yes namestring yes object"notification_rule"yes organization_idOrganizationId yes revisioninteger yes templatestring 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. toolUpstreamToolName yes A notify tool of the Connection's Connector. updated_atTimestamp yes