> ## Documentation Index
> Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List notification dispatches

> List notification dispatches in your organization, newest first. GET /notification-dispatches in the Ravion API reference.



## OpenAPI

````yaml https://api.ravion.com/openapi.yaml get /notification-dispatches
openapi: 3.0.0
info:
  title: Ravion
  version: 0.0.0
servers:
  - url: https://api.ravion.com
security:
  - BearerAuth: []
tags:
  - name: Projects
  - name: Environments
  - name: FeatureFlags
  - name: Pipelines
  - name: PipelineRuns
  - name: TerraformResources
  - name: TerraformExecutionSummaries
  - name: PipelineStepExecutions
  - name: AwsCloudWatch
  - name: AwsAmp
  - name: PipelineVersions
  - name: Organizations
  - name: Stacks
  - name: StackWorkspaces
  - name: Auth
  - name: OAuth
  - name: User
  - name: Health
  - name: Memberships
  - name: ServiceAccounts
  - name: Integrations
  - name: AwsDefaultNetworks
  - name: AwsAccounts
  - name: ApiKeys
  - name: EksPrometheus
  - name: EksLoki
  - name: ExecutionEnvironments
  - name: ModuleDefinitions
  - name: ModuleCategories
  - name: ModuleVersions
  - name: ModuleInstances
  - name: DefaultValueDefinitions
  - name: DefaultValues
  - name: CodeSources
  - name: Github
  - name: GitHub Actions
  - name: Alerts
  - name: Gitlab
  - name: Slack
  - name: Git
  - name: MergeQueues
  - name: Values
  - name: Deployments
  - name: DeploymentResources
  - name: InfrastructureEvents
  - name: WebSocket
  - name: Domains
  - name: AcmCertificates
  - name: NotificationDestinations
  - name: NotificationDispatches
  - name: NotificationEvents
  - name: NotificationRules
  - name: Activity
  - name: Describe
  - name: Reports
  - name: BillingPlans
  - name: BillingAccounts
  - name: BillingCycles
  - name: BillingUsageSummaries
  - name: BillingAddOns
  - name: BillingInvoices
  - name: Authorization
  - name: Sandboxes
  - name: SandboxCommands
  - name: SandboxPorts
  - name: Apps
paths:
  /notification-dispatches:
    get:
      tags:
        - NotificationDispatches
      summary: List notification dispatches
      description: >-
        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.
      operationId: ListNotificationDispatches
      parameters:
        - $ref: '#/components/parameters/PaginationQueryParams.cursor'
        - $ref: '#/components/parameters/PaginationQueryParams.limit'
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.destinationId
        - $ref: '#/components/parameters/NotificationDispatch.ListQueryParams.ruleId'
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.catalogId
        - $ref: '#/components/parameters/NotificationDispatch.ListQueryParams.status'
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.subjectType
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.subjectId
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.createdAtAfter
        - $ref: >-
            #/components/parameters/NotificationDispatch.ListQueryParams.createdAtBefore
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/NotificationDispatch'
                    type: array
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
                required:
                  - data
                  - meta
                type: object
          description: The request has succeeded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: The request is invalid or malformed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You are not authenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: You do not have permission to access this resource.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Client error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors.UserFacingErrorData'
          description: Server error
components:
  parameters:
    PaginationQueryParams.cursor:
      in: query
      name: cursor
      schema:
        nullable: true
        type: string
    PaginationQueryParams.limit:
      in: query
      name: limit
      schema:
        format: int32
        nullable: true
        type: integer
    NotificationDispatch.ListQueryParams.destinationId:
      description: Filter to dispatches sent to any of these notification destinations.
      in: query
      name: destinationId
      schema:
        items:
          type: string
        maxItems: 200
        nullable: true
        type: array
    NotificationDispatch.ListQueryParams.ruleId:
      description: |-
        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.
      in: query
      name: ruleId
      schema:
        items:
          type: string
        maxItems: 200
        nullable: true
        type: array
    NotificationDispatch.ListQueryParams.catalogId:
      description: Filter to dispatches of any of these event catalog ids.
      in: query
      name: catalogId
      schema:
        items:
          type: string
        maxItems: 200
        nullable: true
        type: array
    NotificationDispatch.ListQueryParams.status:
      description: Filter to dispatches in any of these statuses.
      in: query
      name: status
      schema:
        items:
          type: string
        maxItems: 20
        nullable: true
        type: array
    NotificationDispatch.ListQueryParams.subjectType:
      description: >-
        Filter to dispatches whose event's subject is this entity kind, e.g.
        "pipeline_run". Pair with `subjectId` to scope to one specific entity.
      in: query
      name: subjectType
      schema:
        nullable: true
        type: string
    NotificationDispatch.ListQueryParams.subjectId:
      description: >-
        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.
      in: query
      name: subjectId
      schema:
        nullable: true
        type: string
    NotificationDispatch.ListQueryParams.createdAtAfter:
      description: Only dispatches created at or after this time.
      in: query
      name: createdAtAfter
      schema:
        allOf:
          - $ref: '#/components/schemas/UtcDateTime'
        nullable: true
        type: string
    NotificationDispatch.ListQueryParams.createdAtBefore:
      description: Only dispatches created at or before this time.
      in: query
      name: createdAtBefore
      schema:
        allOf:
          - $ref: '#/components/schemas/UtcDateTime'
        nullable: true
        type: string
  schemas:
    NotificationDispatch:
      additionalProperties: false
      properties:
        attemptNumber:
          description: |-
            1-based attempt count for this delivery — this event to this
            destination. Increments by one on each retry of the same delivery.
          format: int32
          type: integer
        catalogId:
          description: Catalog id of the event delivered.
          type: string
        completedAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          description: >-
            When this attempt reached a terminal state (SUCCEEDED or FAILED).
            Absent while PENDING.
          nullable: true
          type: string
        createdAt:
          $ref: '#/components/schemas/UtcDateTime'
        destinationId:
          description: Notification destination this attempt was sent to.
          type: string
        errorMessage:
          description: Failure detail for a FAILED attempt. Absent otherwise.
          nullable: true
          type: string
        eventId:
          description: |-
            Id of the event this dispatch delivered — a PlatformEvent id for a
            live dispatch, or a synthetic id standing in for the ad-hoc/sample
            event when the dispatch came from a notification rule test-send.
            Every attempt of the same delivery shares this id.
          type: string
        id:
          type: string
        nextRetryAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          description: >-
            When a retry of this delivery is scheduled. Set only on a FAILED
            attempt with retries remaining.
          nullable: true
          type: string
        organizationId:
          type: string
        requestedAt:
          allOf:
            - $ref: '#/components/schemas/UtcDateTime'
          description: When this attempt was requested.
        result:
          allOf:
            - $ref: '#/components/schemas/Events.NotificationDispatchResult'
          description: >-
            Delivery outcome, discriminated by destination kind. Set only on a
            SUCCEEDED attempt.
          nullable: true
        ruleIds:
          description: >-
            Notification rule ids that contributed to this dispatch's audience

            resolution. Empty for a notification rule test-send, which
            dispatches

            without going through rule matching.
          items:
            type: string
          type: array
        status:
          $ref: '#/components/schemas/Events.NotificationDispatchStatus'
        subjectId:
          description: Entity id the delivered event's subject is.
          type: string
        subjectType:
          description: Entity kind the delivered event's subject is, e.g. "pipeline_run".
          type: string
      required:
        - id
        - organizationId
        - createdAt
        - destinationId
        - eventId
        - catalogId
        - subjectType
        - subjectId
        - ruleIds
        - attemptNumber
        - status
        - requestedAt
      type: object
    PaginationMeta:
      additionalProperties: false
      properties:
        limit:
          format: int32
          type: integer
        nextCursor:
          type: string
        totalCount:
          format: int32
          type: integer
      required:
        - limit
      type: object
    Errors.UserFacingErrorData:
      additionalProperties: false
      description: |-
        User-facing error presentation data.
        This is what the API returns to the frontend after formatting ErrorData
        using CEL templates from the error registry.

        Used for both:
        - Error fields on domain models (e.g., PipelineRun.error)
        - API error response bodies (HTTP 4xx/5xx responses)
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Errors.Action'
          description: Optional action to help resolve the error
        code:
          description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND"
          type: string
        description:
          description: Additional description with more details
          type: string
        details:
          description: Structured details rendered as user-facing sections.
          items:
            $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection'
          type: array
        isInternal:
          description: >-
            Indicates whether this error is internal (only set when
            ShowInternal=true).

            This allows SUPERADMINs to identify internal errors while viewing
            full details.
          type: boolean
        message:
          description: Main error message (required)
          type: string
        metadata:
          additionalProperties: {}
          description: >-
            Error params/metadata. Stripped for internal errors unless
            superadmin.
          type: object
        requestId:
          description: Request ID for correlating errors with server logs.
          type: string
      required:
        - code
        - message
      type: object
    UtcDateTime:
      description: UTC RFC3339 timestamp with a required Z suffix
      format: date-time
      pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$
      type: string
      x-go-type: apitypes.UTCDateTime
      x-go-type-import:
        name: apitypes
        path: ravion/api-go/pkg/apitypes
    Events.NotificationDispatchResult:
      description: |-
        A notification dispatch's delivery outcome, discriminated by `kind`.
        Carries only the fields meaningful to how that kind of destination
        confirms delivery — an HTTP response for a webhook, a message reference
        for Slack, or a provider message ID for email.
      discriminator:
        mapping:
          email: '#/components/schemas/Events.EmailNotificationDispatchResult'
          slack: '#/components/schemas/Events.SlackNotificationDispatchResult'
          webhook: '#/components/schemas/Events.WebhookNotificationDispatchResult'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/Events.WebhookNotificationDispatchResult'
        - $ref: '#/components/schemas/Events.SlackNotificationDispatchResult'
        - $ref: '#/components/schemas/Events.EmailNotificationDispatchResult'
      type: object
    Events.NotificationDispatchStatus:
      description: Status of a single notification dispatch attempt.
      enum:
        - PENDING
        - SUCCEEDED
        - FAILED
      type: string
    Errors.Action:
      additionalProperties: false
      description: Action to help user resolve the error
      properties:
        label:
          description: Button/link label text
          type: string
        url:
          description: URL to navigate to for resolution
          type: string
      required:
        - label
        - url
      type: object
    Errors.UserFacingErrorDetailSection:
      additionalProperties: false
      description: Structured user-facing error detail section.
      properties:
        items:
          description: List of detail values for this section.
          items:
            type: string
          type: array
        object:
          additionalProperties: {}
          description: Structured detail payload for object rendering.
          type: object
        render:
          description: Rendering hint for clients. Valid values are list or object.
          type: string
        title:
          description: Detail section title shown in the UI.
          type: string
      required:
        - title
        - render
      type: object
    Events.EmailNotificationDispatchResult:
      additionalProperties: false
      description: Delivery outcome recorded for an email dispatch.
      properties:
        kind:
          enum:
            - email
          type: string
        provider_message_id:
          description: >-
            Message ID returned by the email delivery provider, for tracing
            delivery

            and bounce events back to this dispatch.
          type: string
      required:
        - kind
        - provider_message_id
      type: object
    Events.SlackNotificationDispatchResult:
      additionalProperties: false
      description: |-
        Delivery outcome recorded for a Slack dispatch, whether it was sent to a
        channel or as a direct message.
      properties:
        channel_id:
          description: >-
            Slack channel ID the message was posted to — the channel itself for
            a

            channel destination, or the direct-message channel Slack opened for
            a

            DM destination.
          type: string
        kind:
          enum:
            - slack
          type: string
        message_ts:
          description: >-
            Slack's identifier for the posted message ("ts"), used to reference
            or

            update it later.
          type: string
      required:
        - kind
        - message_ts
        - channel_id
      type: object
    Events.WebhookNotificationDispatchResult:
      additionalProperties: false
      description: Delivery outcome recorded for a webhook dispatch.
      properties:
        kind:
          enum:
            - webhook
          type: string
        response_status:
          description: HTTP status code the destination endpoint responded with.
          format: int32
          type: integer
        response_time_ms:
          description: Round-trip time of the delivery attempt, in milliseconds.
          format: int32
          type: integer
      required:
        - kind
        - response_status
        - response_time_ms
      type: object
  securitySchemes:
    BearerAuth:
      scheme: Bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.