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

# Get webhooks

> Returns paginated webhooks history.



## OpenAPI

````yaml /openapi.json get /webhook/history
openapi: 3.0.3
info:
  title: Receive stablecoin. Get fiat in seconds.
  description: Stablecoin collection and settlement layer.
  version: 1.0.0
  contact:
    name: Switch Labs
    email: contact@onswitch.xyz
  license:
    name: Proprietary
  x-tagGroups:
    - name: Institution
      tags:
        - Institution
    - name: Miscellaneous
      tags:
        - Miscellaneous
    - name: History
      tags:
        - History
    - name: Payment
      tags:
        - Payment
    - name: Webhook
      tags:
        - Webhook
    - name: Offramp
      tags:
        - Offramp
    - name: Onramp
      tags:
        - Onramp
    - name: Swap
      tags:
        - Swap
    - name: Developer
      tags:
        - Developer
    - name: Wallet
      tags:
        - Wallet
    - name: Compliance
      tags:
        - Compliance
servers:
  - url: https://api.onswitch.xyz
    description: Production server
security: []
tags:
  - name: Institution
    description: Institution discovery and bank or payment-rail lookup
  - name: Miscellaneous
    description: Requirements, coverage, assets, confirmation, and transaction status
  - name: History
    description: Payment history and summaries for the partner's account
  - name: Payment
    description: Saved payment beneficiaries, payment confirmation, and status
  - name: Webhook
    description: Webhook delivery history and callback resend
  - name: Offramp
    description: Offramp transaction endpoints for converting stablecoins to local currency
  - name: Onramp
    description: Onramp transaction endpoints for converting local currency to stablecoins
  - name: Swap
    description: Swap endpoints for exchanging between different stablecoin assets
  - name: Developer
    description: Developer fee balance and withdrawal
  - name: Wallet
    description: >-
      Wallet endpoints for creating and managing chain abstracted stablecoin
      wallets
  - name: Compliance
    description: AML compliance screening for PEP, sanctions, and other regulatory reasons
paths:
  /webhook/history:
    get:
      tags:
        - Webhook
      summary: Get webhooks
      description: Returns paginated webhooks history.
      operationId: getWebhookHistory
      parameters:
        - name: type
          in: query
          required: false
          description: Filter by webhook type
          schema:
            type: string
            enum:
              - OFFRAMP
              - ONRAMP
              - SWAP
              - RECEIVE
              - SEND
        - name: status
          in: query
          required: false
          description: Filter by status
          schema:
            type: string
            enum:
              - SUCCESSFUL
              - FAILED
        - name: search
          in: query
          required: false
          description: Filter by reference or keyword
          schema:
            type: string
            maxLength: 200
        - name: start_date
          in: query
          required: false
          description: Filter by start date e.g 2026-01-01
          schema:
            type: string
            format: date-time
        - name: end_date
          in: query
          required: false
          description: Filter by end date e.g 2026-01-01
          schema:
            type: string
            format: date-time
        - name: page
          in: query
          required: false
          description: Results page number. Default 1.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          description: Results per page. Default 10, maximum 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
      responses:
        '200':
          description: Webhook history retrieved successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - message
                  - timestamp
                  - data
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  data:
                    type: object
                    required:
                      - data
                      - page
                      - limit
                      - total
                      - pages
                    properties:
                      data:
                        type: array
                        description: Webhook records for the current page
                        items:
                          type: object
                          properties:
                            reference:
                              type: string
                              description: Identifier for this webhook
                            url:
                              type: string
                              format: uri
                            type:
                              type: string
                              enum:
                                - OFFRAMP
                                - ONRAMP
                                - SWAP
                                - WALLET
                            status:
                              type: string
                              enum:
                                - SUCCESSFUL
                                - FAILED
                              description: Status of the webhook
                            request:
                              type: object
                              nullable: true
                              additionalProperties: true
                              description: Request body sent to the developer URL
                            response:
                              type: object
                              nullable: true
                              additionalProperties: true
                              description: Response body received from the webhook URL
                            error:
                              type: string
                              nullable: true
                            retry_count:
                              type: integer
                              minimum: 0
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                      page:
                        type: integer
                        description: Results page number. Default 1.
                      limit:
                        type: integer
                        description: Results per page. Default 10, maximum 100.
                      total:
                        type: integer
                        description: Total matching webhooks (all pages)
                      pages:
                        type: integer
                        description: Total number of pages for the current limit
              example:
                success: true
                message: Webhook history fetched successfully
                timestamp: '2026-04-18T14:22:08.631Z'
                data:
                  data:
                    - reference: wh_8k2m9p1q4r7s0t3u6v
                      url: https://hooks.partner.dev/switch/inbound
                      type: OFFRAMP
                      status: SUCCESSFUL
                      request:
                        event: payment.completed
                        reference: a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90
                        status: COMPLETED
                      response:
                        received: true
                        http_status: 200
                      error: null
                      retry_count: 0
                      created_at: '2026-04-18T13:08:45.112Z'
                      updated_at: '2026-04-18T13:08:45.418Z'
                  page: 1
                  limit: 10
                  total: 384
                  pages: 39
        '400':
          $ref: '#/components/responses/BadRequest'
      security:
        - ServiceKey: []
components:
  responses:
    BadRequest:
      description: Bad request - Invalid input parameters or validation error
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - timestamp
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                description: Error message describing what went wrong
              timestamp:
                type: string
                format: date-time
              data:
                description: Additional error details
                nullable: true
          example:
            success: false
            message: amount must be greater than 0 for the selected corridor
            timestamp: '2026-04-18T14:22:08.631Z'
            data: null
  securitySchemes:
    ServiceKey:
      type: apiKey
      in: header
      name: x-service-key
      description: Service key for API authentication

````