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

# List partner webhook events from the local delivery log

> Returns partner-scoped webhook events with deterministic cursor pagination for recovery and audit workflows. This endpoint reads CashWeb delivery records only and does not enrich each row with downstream delivery telemetry.



## OpenAPI

````yaml /openapi/openapi.json get /partner/webhooks/events
openapi: 3.1.0
info:
  title: CashWeb Partner API
  description: >-
    CashWeb Partner API enables crypto-to-fiat offramp transactions. Create
    quotes, manage transactions, receive lifecycle webhooks, and reconcile
    revenue.
  contact:
    name: Michael Anyi
    email: michael@cashweb.cash
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api-staging.cashweb.cash/api/v1
    description: Staging environment
  - url: https://api.cashweb.cash/api/v1
    description: Production environment
security: []
paths:
  /partner/webhooks/events:
    get:
      tags:
        - Partner API
      summary: List partner webhook events from the local delivery log
      description: >-
        Returns partner-scoped webhook events with deterministic cursor
        pagination for recovery and audit workflows. This endpoint reads CashWeb
        delivery records only and does not enrich each row with downstream
        delivery telemetry.
      operationId: list_webhook_events
      parameters:
        - name: transaction_id
          in: query
          description: Filter by aggregate transaction identifier.
          required: false
          schema:
            type: string
            format: uuid
          example: 01917f00-7b4c-7f56-8a2b-15998d58c9f3
        - name: merchant_reference
          in: query
          description: Filter by canonical merchant reference.
          required: false
          schema:
            type: string
          example: order-4551
        - name: event_type
          in: query
          description: Filter by consumer-facing webhook event type.
          required: false
          schema:
            type: string
          example: transaction.completed
        - name: publish_status
          in: query
          description: Filter by local publish status.
          required: false
          schema:
            type: string
          example: dispatched
        - name: from
          in: query
          description: Inclusive start time in RFC3339.
          required: false
          schema:
            type: string
          example: '2026-02-01T00:00:00Z'
        - name: to
          in: query
          description: Inclusive end time in RFC3339.
          required: false
          schema:
            type: string
          example: '2026-02-12T23:59:59Z'
        - name: cursor
          in: query
          description: Opaque cursor returned by the previous response.
          required: false
          schema:
            type: string
          example: >-
            eyJjcmVhdGVkX2F0IjoiMjAyNi0wMi0xMlQxMjozMDowMFoiLCJpZCI6IjAxOTE3ZjAwIn0
        - name: limit
          in: query
          description: Requested page size.
          required: false
          schema:
            type: integer
            format: int32
            maximum: 100
            minimum: 1
          example: 20
      responses:
        '200':
          description: Webhook event list retrieved
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiResponse_PartnerWebhookEventListResponse
              example:
                data:
                  data:
                    - aggregate_id: 01917f00-7b4c-7f56-8a2b-15998d58c9f3
                      attempts: 2
                      created_at: '2026-02-12T12:05:00Z'
                      event_id: 01917f00-7b4c-7f56-8a2b-15998d58c9f3
                      event_type: transaction.completed
                      last_error: null
                      merchant_reference: order-4551
                      publish_status: dispatched
                      updated_at: '2026-02-12T12:05:10Z'
                  has_more: false
                  limit: 20
                  next_cursor: null
                success: true
        '400':
          description: Invalid webhook event query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: BAD_REQUEST
                  message: >-
                    publish_status must be one of pending, processing,
                    dispatched, failed, terminal_failed
                  timestamp: '2026-02-12T12:00:00Z'
        '401':
          description: Missing or invalid partner API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - PartnerApiKey: []
components:
  schemas:
    ApiResponse_PartnerWebhookEventListResponse:
      type: object
      description: Standard API response wrapper for all successful responses
      required:
        - success
        - data
      properties:
        data:
          type: object
          description: Cursor-based partner webhook event list from the local outbox log.
          required:
            - data
            - has_more
            - limit
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/PartnerWebhookEventListItem'
              description: Current page of webhook events.
            has_more:
              type: boolean
              example: false
            limit:
              type: integer
              format: int32
              description: Applied page size after server-side clamping.
              example: 20
            next_cursor:
              type:
                - string
                - 'null'
              description: Opaque cursor for next page retrieval.
              example: >-
                eyJjcmVhdGVkX2F0IjoiMjAyNi0wMi0xMlQxMjozMDowMFoiLCJpZCI6IjAxOTE3ZjAwIn0
        message:
          type:
            - string
            - 'null'
          description: Optional message for additional information
        success:
          type: boolean
          description: Indicates if the request was successful
          example: 'true'
    ErrorResponse:
      type: object
      description: Error response structure for OpenAPI documentation
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetails'
          description: Error details
    PartnerWebhookEventListItem:
      type: object
      description: Single partner webhook event row from the local outbox event log.
      required:
        - event_id
        - event_type
        - aggregate_id
        - publish_status
        - attempts
        - created_at
        - updated_at
      properties:
        aggregate_id:
          type: string
          format: uuid
          description: Aggregate transaction identifier associated with this event.
          example: 01917f00-7b4c-7f56-8a2b-15998d58c9f3
        attempts:
          type: integer
          format: int32
          description: Total publish attempts recorded in the local outbox.
          example: 2
        created_at:
          type: string
          format: date-time
          description: Event creation timestamp in UTC RFC3339.
          example: '2026-02-12T12:05:00Z'
        event_id:
          type: string
          format: uuid
          example: 01917f00-7b4c-7f56-8a2b-15998d58c9f3
        event_type:
          type: string
          description: Consumer-facing webhook event type.
          example: transaction.completed
        last_error:
          type:
            - string
            - 'null'
          description: Last recorded local publish error when applicable.
          example: upstream timeout
        merchant_reference:
          type:
            - string
            - 'null'
          description: Partner-owned canonical reference when available.
          example: order-4551
        publish_status:
          type: string
          description: Local outbox publish state.
          example: dispatched
        updated_at:
          type: string
          format: date-time
          description: Last event update timestamp in UTC RFC3339.
          example: '2026-02-12T12:05:10Z'
    ErrorDetails:
      type: object
      description: Error details structure
      required:
        - message
        - code
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        timestamp:
          type: string
          format: date-time
          description: Timestamp when the error occurred
  securitySchemes:
    PartnerApiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````