> ## 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 Webhooks

> Retrieve a paginated list of webhook endpoints.



## OpenAPI

````yaml get /v1/aggregators/{raast-aggregator-id}/webhooks
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:
    get:
      tags:
        - Webhooks
      summary: List Webhooks
      description: Retrieve a paginated list of webhook endpoints.
      parameters:
        - $ref: '#/components/parameters/WebhookListLimitParam'
        - $ref: '#/components/parameters/WebhookListOffsetParam'
      responses:
        '200':
          $ref: '#/components/responses/ListWebhookResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKey: []
components:
  parameters:
    WebhookListLimitParam:
      name: limit
      in: query
      required: false
      schema:
        type: string
        example: '10'
      description: Maximum number of webhook endpoints to include in the response
    WebhookListOffsetParam:
      name: offset
      in: query
      required: false
      schema:
        type: string
        example: '0'
      description: Number of webhook endpoints to skip before starting the result set
  responses:
    ListWebhookResponse:
      description: This response contains a paginated list of webhook endpoints
      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 endpoints
                    properties:
                      endpoints:
                        type: array
                        description: List of webhook endpoints returned in the result set
                        items:
                          $ref: '#/components/schemas/Webhook'
                      count:
                        type: string
                        example: '1'
                    required:
                      - endpoints
                      - count
          examples:
            WebhookList:
              value:
                api_version: v1
                data:
                  endpoints:
                    - token: wh_f52d84b4-a140-4a3a-b707-80644232e926
                      aggregator_id: agg_2288490a-2176-4de5-b373-0ffb6f8e2e6e
                      url: https://github.com/HasCold
                      description: this is the testing url
                      enabled: true
                      event_filter_json: '["payment.created","payment.authorized"]'
                      created_at: '2025-12-02T12:48:35Z'
                      updated_at: '2025-12-02T12:53:10Z'
                      secret: 9sU3KVM5iQYZsxt40st1nkJsvbyuLnquB3Re1Q7k08w=
                      secret_version: 1
                      secret_rotated_at: '2025-12-02T12:48:35Z'
                  count: '1'
    Unauthorized:
      description: Unauthorized
      headers:
        Content-Length:
          $ref: '#/components/headers/ContentLengthHeader'
        Date:
          $ref: '#/components/headers/DateHeader'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorEnvelope'
          examples:
            Unauthorized:
              value:
                api_version: v1
                error:
                  code: error.unauthorized_access
                  message: partner access key is required in request header
  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
    Webhook:
      type: object
      properties:
        token:
          type: string
        aggregator_id:
          type: string
        url:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        event_filter_json:
          type: string
        secret:
          type: string
          description: >-
            Base64-encoded signing secret (returned on create or rotate).
            Base64-decode it and use the bytes as the HMAC-SHA256 key when
            verifying webhook deliveries; see webhooks documentation for the
            signature algorithm.
        secret_version:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        secret_rotated_at:
          type: string
          format: date-time
    ApiErrorEnvelope:
      type: object
      description: Error wrapper that includes the API version and error metadata
      properties:
        api_version:
          type: string
          description: Indicates the API version associated with the response
          example: v1
        error:
          description: Structured error details describing why the request failed
          allOf:
            - $ref: '#/components/schemas/ErrorResponse'
          example:
            code: error.unauthorized_access
            message: partner access key is required in request header
    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
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-SFPY-AGGREGATOR-SECRET-KEY
      in: header

````