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

# Get webhook URLs

> Retrieve your registered webhook URLs. Your collection_url is used for collection events, virtual account events, and customer KYC events. Required scope: `webhook:read`.



## OpenAPI

````yaml /api-reference/webhook/get-openapi.json get /api/external/webhook
openapi: 3.1.0
info:
  title: Blaaiz Platform API - Get Webhook URLs
  version: 1.0.0
  description: Retrieve your registered webhook URLs.
servers:
  - url: https://api-prod.blaaiz.com
  - url: https://api-dev.blaaiz.com
security: []
tags:
  - name: Webhook
paths:
  /api/external/webhook:
    get:
      tags:
        - Webhook
      summary: Get webhook URLs
      description: >-
        Retrieve your registered webhook URLs. Your collection_url is used for
        collection events, virtual account events, and customer KYC events.
        Required scope: `webhook:read`.
      responses:
        '200':
          description: Webhook URLs retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfig'
              example:
                payout_url: https://yourapp.com/webhooks/payout
                collection_url: https://yourapp.com/webhooks/collection
                created_at: '2024-01-01T00:00:00Z'
                updated_at: '2024-01-15T10:30:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Invalid or missing access token
        '404':
          description: No webhook URLs configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: No webhook URLs configured
      security:
        - oauth2ClientCredentials:
            - webhook:read
components:
  schemas:
    WebhookConfig:
      type: object
      properties:
        payout_url:
          type: string
          format: uri
        collection_url:
          type: string
          format: uri
          description: URL receiving collection, virtual account, and customer KYC events.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - payout_url
        - collection_url
        - created_at
        - updated_at
    Error:
      type: object
      properties:
        status:
          type: boolean
        message:
          type: string
      required:
        - status
        - message
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      description: >-
        Use your OAuth client credentials to obtain a short-lived Bearer token
        from POST /oauth/token.
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            webhook:read: Read webhook configuration.

````