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

# List Webhook Events

> List persisted Payment Webhook events



## OpenAPI

````yaml api-reference/payment-webhooks/openapi.json GET /v1/webhook_events
openapi: 3.1.0
info:
  title: Modulus Payment Webhooks API
  version: 1.0.0
  description: Manage Payment Webhook endpoints, signing secrets, and persisted events.
servers:
  - url: https://api.sbx.moduluslabs.io
    description: >-
      Sandbox. Use the base URL supplied with your production credentials when
      going live.
security:
  - ApiKey: []
tags:
  - name: Webhook endpoints
  - name: Signing secrets
  - name: Webhook events
paths:
  /v1/webhook_events:
    get:
      tags:
        - Webhook events
      summary: List webhook events
      description: >-
        Requires `webhooks.read`. Partner- and merchant-scoped keys must supply
        `merchant_branch_reference_number`; branch keys derive it from
        authentication.
      operationId: listWebhookEvents
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
        - name: merchant_branch_reference_number
          in: query
          schema:
            type: string
          description: Required for partner- and merchant-scoped keys.
        - name: type
          in: query
          description: Return only events of this payment event type.
          schema:
            $ref: '#/components/schemas/EventType'
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Comma-separated statuses: `PENDING`, `SUBMITTING`, `SUBMIT_FAILED`,
            `SUBMITTED`, `DELIVERED`, `EXHAUSTED`, or `NOT_SUBSCRIBED`.
        - name: date_from
          in: query
          description: >-
            Inclusive lower bound for event creation time, as an RFC 3339
            timestamp.
          schema:
            type: string
            format: date-time
        - name: date_to
          in: query
          description: >-
            Inclusive upper bound for event creation time, as an RFC 3339
            timestamp.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Event page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    PageSize:
      name: page_size
      in: query
      description: Maximum resources to return. Defaults to 20; allowed range is 1 to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Cursor:
      name: cursor
      in: query
      description: Opaque `next_cursor` value returned by the previous page.
      schema:
        type: string
        format: uuid
  schemas:
    EventType:
      type: string
      description: Payment event type delivered to a subscribed endpoint.
      enum:
        - payment.succeeded
        - payment.declined
        - payment.failed
        - payment.expired
    EventList:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          description: Webhook event summaries in the current page.
          items:
            $ref: '#/components/schemas/WebhookEventSummary'
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Cursor-pagination state for this result page.
    WebhookEventSummary:
      type: object
      required:
        - id
        - type
        - status
        - created_at
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Unique webhook event identifier. Use it to retrieve or retrigger
            this event.
        type:
          allOf:
            - $ref: '#/components/schemas/EventType'
          description: Payment event type.
        status:
          type: string
          enum:
            - PENDING
            - SUBMITTING
            - SUBMIT_FAILED
            - SUBMITTED
            - DELIVERED
            - EXHAUSTED
            - NOT_SUBSCRIBED
          description: >-
            Receiver submission status. `SUBMITTED` means accepted for delivery,
            not confirmed merchant receipt.
        created_at:
          type: string
          format: date-time
          description: UTC RFC 3339 timestamp when the webhook event was created.
    Pagination:
      type: object
      required:
        - page_size
        - has_more
        - next_cursor
      properties:
        page_size:
          type: integer
          description: Number of resources returned in this page.
        has_more:
          type: boolean
          description: Whether another page is available.
        next_cursor:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Opaque cursor for the next page, or `null` when this is the last
            page.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Error returned for an unsuccessful Payment Webhooks API request.
          required:
            - code
            - message
            - correlation_id
          properties:
            code:
              type: string
              description: Machine-readable error code.
              example: INVALID_DESCRIPTION
            message:
              type: string
              description: >-
                Human-readable validation message. Public field tokens retain
                their API spelling; do not branch on its wording.
              example: description must be 255 characters or fewer.
            correlation_id:
              type: string
              format: uuid
              description: Unique request identifier. Include it when contacting support.
  responses:
    BadRequest:
      description: The request failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: The API key is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: The key lacks the required scope or resource ownership.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: The resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: An internal error occurred.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: A Modulus API key with the required webhook scope.

````