List notification dispatches
List notification dispatches in your organization, newest first. A dispatch is one delivery attempt of one event to one destination: a notification rule matches an event, resolves its audience to notification destinations, and records one dispatch per destination it attempted to deliver to. A dispatch that is retried does not create a new event — the retry is a new dispatch row that shares the original delivery's eventId and destinationId with attemptNumber incremented by one, so the full history of one delivery is every row sharing those two fields, ordered by attemptNumber. Returns a paginated collection with cursor metadata for fetching additional pages. Available to organizations with notifications enabled; refused with 403 otherwise.
Preview feature. Requires the notifications feature flag to be enabled for your organization.
Request
- Base URLhttps://api.ravion.com
- AuthHTTP bearer
Query parameters
Filter to dispatches sent to any of these notification destinations.
Filter to dispatches attributed to any of these notification rules. A dispatch's ruleIds can list more than one contributing rule; this matches a dispatch if any of them is in the given list. A rule test-send's dispatches have no rule attribution and never match.
Filter to dispatches of any of these event catalog ids.
Filter to dispatches in any of these statuses.
Filter to dispatches whose event's subject is this entity kind, e.g. "pipeline_run". Pair with subjectId to scope to one specific entity.
Filter to dispatches whose event's subject is this entity id. Pair with subjectType to disambiguate ids that are only unique within their entity kind.
UTC RFC3339 timestamp with a required Z suffix
Only dispatches created at or after this time.
UTC RFC3339 timestamp with a required Z suffix
Only dispatches created at or before this time.
Response
The request has succeeded.
Changes
No recorded changes to this operation across all 2 revisions of this API.