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

# List Webhooks

> Get the list of webhooks set up for your platform.

The list includes both webhooks that are switched on and ones that are
switched off, and it is split into pages. Pass `is_active=true` to get only
the live ones — the address Finogate is actually sending to right now.



## OpenAPI

````yaml GET /v1/platform/webhooks
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: fees
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: document mailing
  - name: merchant onboarding
  - name: catalog
  - name: webhooks
  - name: screening
  - name: Platform - File Scanning
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: Card Transfers
  - name: embed-tokens
paths:
  /v1/platform/webhooks:
    get:
      tags:
        - webhooks
      summary: List Webhooks
      description: >-
        Get the list of webhooks set up for your platform.


        The list includes both webhooks that are switched on and ones that are

        switched off, and it is split into pages. Pass `is_active=true` to get
        only

        the live ones — the address Finogate is actually sending to right now.
      operationId: list_webhooks_v1_platform_webhooks_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: How many webhooks to return per page (1 to 200).
            examples:
              - 50
            default: 50
            title: Limit
          description: How many webhooks to return per page (1 to 200).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: How many webhooks to skip before this page starts.
            examples:
              - 0
            default: 0
            title: Offset
          description: How many webhooks to skip before this page starts.
        - name: is_active
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              Narrow the list to switched-on (`true`) or switched-off (`false`)
              webhooks. Omit it to get both, which is the default.
            examples:
              - true
            title: Is Active
          description: >-
            Narrow the list to switched-on (`true`) or switched-off (`false`)
            webhooks. Omit it to get both, which is the default.
      responses:
        '200':
          description: A page of your platform's webhooks.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponse'
              example:
                status_code: 200
                data:
                  - id: c4f2e8a1-3b7d-4e9f-a1c2-6d8e3f7a9b0c
                    url: https://example.com/webhooks
                    events:
                      - payment_intent.succeeded
                      - payment_intent.failed
                      - payout.settled
                    is_active: true
                    created_at: '2026-04-01T10:30:00Z'
                row_count: 1
                query_generated_time: 1712847600000
                limit: 50
                current_page: 1
                total_page_number: 1
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    ListResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
        row_count:
          type: integer
          minimum: 0
          title: Row Count
          description: Total rows matching the request filters (not just this page).
        limit:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Limit
          description: >-
            Page size used for this response. Null for cursor-paginated
            endpoints.
        current_page:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Current Page
          description: >-
            1-indexed page number for this response. Null for cursor-paginated
            endpoints.
        total_page_number:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Total Page Number
          description: >-
            Total number of pages given the current limit. Null for
            cursor-paginated endpoints.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor for the next page, if available.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
        - row_count
      title: ListResponse
      description: |-
        Standard response wrapper for list responses.

        Declare ``ListResponse[list[SomeModel]]`` to render the real ``data``
        array schema in OpenAPI/Swagger; a bare ``ListResponse`` leaves ``data``
        untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````