> ## Documentation Index
> Fetch the complete documentation index at: https://safepay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Webhook Delivery

> Retrieve a paginated list of webhook deliveries. It supports pagination, filtering by `status`, `type` and `event_id`.



## OpenAPI

````yaml get /v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries
openapi: 3.1.0
info:
  title: Raast Wire
  version: 1.0.0
  description: ''
servers:
  - url: https://api.getsafepay.com/raastwire
security: []
tags:
  - name: Aggregators
  - name: Access Keys
  - name: Merchants
  - name: Raast Merchants
  - name: Payments
  - name: Refunds
  - name: QRs
  - name: Utilities
  - name: Aliases
  - name: Ledgers
  - name: Webhooks
paths:
  /v1/aggregators/{raast-aggregator-id}/webhooks/{endpoint}/deliveries:
    parameters:
      - $ref: '#/components/parameters/AggregatorIdParam'
      - $ref: '#/components/parameters/WebhookEndpointParam'
    get:
      tags:
        - Webhooks
      summary: List Webhook Delivery
      description: >-
        Retrieve a paginated list of webhook deliveries. It supports pagination,
        filtering by `status`, `type` and `event_id`.
      parameters:
        - $ref: '#/components/parameters/WebhookDeliveryListTypeParam'
        - $ref: '#/components/parameters/WebhookDeliveryListEventIdParam'
        - $ref: '#/components/parameters/WebhookDeliveryListStatusParam'
        - $ref: '#/components/parameters/WebhookDeliveryListLimitParam'
        - $ref: '#/components/parameters/WebhookDeliveryListOffsetParam'
      responses:
        '200':
          $ref: '#/components/responses/ListWebhookDeliveryResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
        - apiKey: []
components:
  parameters:
    AggregatorIdParam:
      name: raast-aggregator-id
      in: path
      required: true
      schema:
        type: string
        example: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
      description: The unique identifier for the aggregator
    WebhookEndpointParam:
      name: endpoint
      in: path
      required: true
      schema:
        type: string
        example: wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3
      description: The unique identifier for the webhook endpoint
    WebhookDeliveryListTypeParam:
      name: type
      in: query
      required: false
      schema:
        type: string
        enum:
          - payment.created
          - payment.pending_authorization
          - payment.authorized
          - payment.completed
          - payment.settled
          - payment.refunded
          - payment.refund_partial
          - payment.rejected
          - payment.failed
          - payment.reversed
          - payment.voided
          - settlement.created
          - settlement.processing
          - settlement.completed
          - settlement.failed
          - settlement.on_hold
          - settlement.reversed
          - refund.created
          - refund.completed
          - refund.failed
          - refund.canceled
        example: refund.created
      description: Limit results to Webhook deliveries of the given type
    WebhookDeliveryListEventIdParam:
      name: event_id
      in: query
      required: false
      description: Filter Webhook deliveries by event_id.
      schema:
        type: string
        example: txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291
    WebhookDeliveryListStatusParam:
      name: status
      in: query
      required: false
      description: Filter Webhook deliveries by their status.
      schema:
        type: string
        enum:
          - WD_PENDING
          - WD_DELIVERED
          - WD_FAILED
          - WD_DEAD
        example: WD_DELIVERED
      example: WD_DELIVERED
    WebhookDeliveryListLimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: string
        example: '10'
      description: Maximum number of Webhook deliveries to include in the response
    WebhookDeliveryListOffsetParam:
      name: offset
      in: query
      required: false
      schema:
        type: string
        example: '0'
      description: Number of Webhook deliveries to skip before starting the result set
  responses:
    ListWebhookDeliveryResponse:
      description: This response contains a paginated list of webhook deliveries.
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/StandardResponse'
              - type: object
                properties:
                  data:
                    type: object
                    description: Paginated collection of webhook deliveries
                    properties:
                      deliveries:
                        type: array
                        description: List of webhook deliveries returned in the result set
                        items:
                          $ref: '#/components/schemas/WebhookDelivery'
                      count:
                        type: string
                        example: '1'
                    required:
                      - deliveries
                      - count
          examples:
            WebhookDeliveryList:
              value:
                api_version: v1
                data:
                  deliveries:
                    - token: whd_f35737a8-60d0-4d62-8259-9cade007570a
                      endpoint_token: wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3
                      aggregator_id: agg_7f500b19-a5e4-4410-b334-5653367ebdf6
                      event_id: txnlog_5246fdcc-6c86-49bb-9da2-aa38262e0291
                      type: payment.rejected
                      status: WD_DEAD
                      attempts: 0
                      last_error: status 422
                      next_attempt_at: '2025-12-17T14:30:03Z'
                      created_at: '2025-12-17T14:30:02Z'
                      delivered_at: null
                    - token: whd_3c67553a-54ff-4bf7-a2a4-a3db233fd4d8
                      endpoint_token: wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3
                      aggregator_id: agg_7f500b19-a5e4-4410-b334-5653367ebdf6
                      event_id: txnlog_1a574d66-9bdf-48ae-a858-802951c46705
                      type: payment.completed
                      status: WD_DEAD
                      attempts: 0
                      last_error: status 422
                      next_attempt_at: '2025-12-17T12:00:48Z'
                      created_at: '2025-12-17T12:00:47Z'
                      delivered_at: null
                    - token: whd_5521cdb9-fe09-4fa4-a63b-0c3637af7810
                      endpoint_token: wh_6b849c6f-c091-4ad3-b7a9-de06415c6db3
                      aggregator_id: agg_7f500b19-a5e4-4410-b334-5653367ebdf6
                      event_id: txnlog_9b62b0e1-4493-45cd-a55d-11c37d60e6d2
                      type: payment.created
                      status: WD_DEAD
                      attempts: 0
                      last_error: status 422
                      next_attempt_at: '2025-12-17T12:00:48Z'
                      created_at: '2025-12-17T12:00:46Z'
                      delivered_at: null
                  count: '10'
    BadRequest:
      description: Bad request
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/ErrorResponse'
              - type: object
                properties:
                  code:
                    example: error.bad_request
                  message:
                    example: Invalid request parameters
  headers:
    ContentLengthHeader:
      schema:
        type: string
        example: '256'
    DateHeader:
      schema:
        type: string
        example: Sat, 12 Aug 2023 08:55:04 GMT
  schemas:
    StandardResponse:
      type: object
      description: Standard response structure for successful operations
      properties:
        api_version:
          type: string
          example: v1
          description: The current version of the API spec
        data:
          type: object
          description: Contains the response data
    WebhookDelivery:
      type: object
      description: Delivery attempt metadata for a webhook event.
      properties:
        token:
          type: string
          description: Public token representing the webhook delivery.
        endpoint_token:
          type: string
          description: Identifier of the webhook endpoint this delivery was sent to.
        aggregator_id:
          type: string
          description: Aggregator that owns the webhook endpoint.
        event_id:
          type: string
          description: Event identifier associated with this delivery.
        type:
          type: string
          description: Event type delivered.
        payload_json:
          type: string
          description: Raw JSON payload delivered to the endpoint.
        status:
          type: string
          description: Current status of the delivery attempt.
        attempts:
          type: integer
          description: Number of attempts made to deliver the payload.
        last_error:
          type: string
          description: Last error message if delivery failed.
        next_attempt_at:
          $ref: '#/components/schemas/Timestamp'
          description: Timestamp for the next scheduled retry, if applicable.
        created_at:
          $ref: '#/components/schemas/Timestamp'
        delivered_at:
          $ref: '#/components/schemas/Timestamp'
    ErrorResponse:
      type: object
      description: Standard error response structure
      properties:
        code:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
    Timestamp:
      type: string
      format: date-time
      description: ISO 8601 timestamp in UTC
      example: '2025-03-13T09:12:34.000Z'
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-SFPY-AGGREGATOR-SECRET-KEY
      in: header

````