Notification channels, delivery rules, event types, and notification history.
/notifications/event-typesList available notification event types
Returns the list of event types that notification rules can subscribe to. Includes shortcut types (e.g., 'any terminal status') that expand into individual event types at rule creation time.
Responses
Responses
A list of available notification event types.
/notifications/channelsList notification channels
Lists notification channels for the organization, optionally filtered by team or member ownership.
Parameters
limitinteger
The maximum number of items to list.
"int32"0100100markerstring
The pagination token returned from the previous list operation.
teamIdstring
Filter by team ID.
"A1B2C3D4E5"120"^[A-Z0-9]{1,20}$"memberIdstring
Filter by member ID.
"A1B2C3D4E5"120"^[A-Z0-9]{1,20}$"Responses
Responses
A list of notification channels.
/notifications/channelsCreate a notification channel
Creates a new notification channel for delivering notifications to a team or member destination (email or webhook).
Request Body
Responses
Responses
The notification channel was created successfully.
/notifications/channels/{channel}Get notification channel details
Returns the details of a specific notification channel.
Responses
Responses
The notification channel details.
/notifications/channels/{channel}Delete a notification channel
Soft-deletes a notification channel. The channel is marked as deleted but preserved for delivery log history.
Responses
Responses
The notification channel was deleted successfully.
/notifications/channels/{channel}Update a notification channel
Updates the configuration of an existing notification channel.
Request Body
Responses
Responses
The notification channel was updated successfully.
/notifications/channels/{channel}/testSend a test notification
Sends a test notification to verify the channel is configured correctly. On success, sets the channel's verifiedAt timestamp.
Responses
Responses
The test notification was sent successfully.
/notifications/rulesList notification rules
Lists notification rules for the organization, optionally filtered by team, member, resource type, or scope type.
Parameters
limitinteger
The maximum number of items to list.
"int32"0100100markerstring
The pagination token returned from the previous list operation.
teamId
Filter by team ID.
memberId
Filter by member ID.
resourceTypestring
Filter rules by resource type.
scopeTypestring
Filter rules by scope type.
"resource""team""organization""own_resources"Responses
Responses
A list of notification rules.
/notifications/rulesCreate a notification rule
Creates a new notification rule that maps event types to notification channels.
Request Body
Responses
Responses
The notification rule was created successfully.
/notifications/rules/{rule}Get notification rule details
Returns the details of a specific notification rule.
Responses
Responses
The notification rule details.
/notifications/rules/{rule}Delete a notification rule
Deletes a notification rule. Future events will no longer match this rule.
Responses
Responses
The notification rule was deleted successfully.
/notifications/rules/{rule}Update a notification rule
Updates an existing notification rule (including enable/disable).
Request Body
Responses
Responses
The notification rule was updated successfully.
/notificationsList notification delivery history
Lists notification delivery log entries, optionally filtered by channel, rule, or status.
Parameters
limitinteger
The maximum number of items to list.
"int32"0100100markerstring
The pagination token returned from the previous list operation.
channelIdstring
Filter by channel ID.
"A1B2C3D4E5"120"^[A-Z0-9]{1,20}$"ruleIdstring
Filter by rule ID.
"A1B2C3D4E5"120"^[A-Z0-9]{1,20}$"statusstring
Filter by delivery status.
"pending""delivering""delivered""failed""skipped"Responses
Responses
A list of notification delivery log entries.