Notifications
The Notifications API manages filtered delivery subscriptions for your environment.
Notifications are separate from the Webhooks API. Notifications apply per-subscription filters before delivery. Webhooks are direct event subscriptions without this filtering layer.
Shared guidance
- Notifications subscriptions overview - filtering rules, status behavior, and authentication notes
- Notification filters overview - filter concepts, supported input groups, and common examples
- Verify notification deliveries - validate incoming notification requests with the token or RSA signature
API requests
- Test notification filter -
POST /v1/notifications/test-filter- evaluate a notification filter against an event payload - List notification subscriptions -
GET /v1/notifications/subscriptions- return environment configuration and existing subscriptions - Create notification subscription -
POST /v1/notifications/subscriptions- create a filtered notification subscription - Pause notification subscription -
PATCH /v1/notifications/subscriptions/{id}/pause- pause delivery for one subscription - Resume notification subscription -
PATCH /v1/notifications/subscriptions/{id}/resume- reactivate a paused subscription - List notification subscription executions -
GET /v1/notifications/subscriptions/{subscriptionId}/executions- return stored filter evaluation records for a subscription - Get notification subscription execution -
GET /v1/notifications/subscriptions/{subscriptionId}/executions/{executionId}- return one stored execution record with filter context