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

# Get webhook configuration

> Returns the current webhook configuration for the authenticated partner, including the webhook URL and a masked preview of the secret.



## OpenAPI

````yaml /raas-widgets/openapi.json get /partner/webhooks/config
openapi: 3.0.0
info:
  title: RaaS Widgets Partner API
  description: >
    REST API for RaaS Widgets partner integrations. Create magic links for
    embeddable flows, manage end users, track transfer operations, handle CIP
    verification, and configure webhooks for real-time event notifications.


    This specification covers the **Partner-accessible API** only (`X-API-Key`
    against `/partner/*`). Widget and Superadmin APIs are out of scope.


    ## Authentication


    All endpoints require an API key passed in the `X-API-Key` header. Use
    `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for
    production.


    ## Environments


    | Environment | Base URL |

    |---|---|

    | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` |
  version: 1.18.0
  contact: {}
servers:
  - url: https://raas-widgets-backend-sandbox.up.railway.app
    description: Sandbox
security: []
tags:
  - name: Partner - Magic Links
    description: Create, list, and manage magic links for flows
  - name: Partner - Flows
    description: List enabled flows and the full flow catalog
  - name: Partner - Users
    description: View and manage end users associated with your partner account
  - name: Partner - Operations
    description: Track money transfer operations and their statuses
  - name: Partner - Requests
    description: List and inspect money-request records
  - name: Partner - Deferred Payouts
    description: List, inspect, and cancel deferred payout remittances
  - name: Partner - CIP
    description: Customer Identification Program (CIP) verification management
  - name: Partner - Data Requests
    description: Fulfill data requests for additional user information
  - name: Partner - Settings
    description: Configure partner-level settings (redirect URLs, logo, etc.)
  - name: Partner - Webhooks
    description: Configure webhook endpoints and inspect delivery history
  - name: Partner - Pricing
    description: >-
      Indicative pre-quote summaries (best / worst / averages) for partner
      integrations
paths:
  /partner/webhooks/config:
    get:
      tags:
        - Partner - Webhooks
      summary: Get webhook configuration
      description: >-
        Returns the current webhook configuration for the authenticated partner,
        including the webhook URL and a masked preview of the secret.
      operationId: PartnerWebhooksController_getConfig
      parameters: []
      responses:
        '200':
          description: Webhook configuration retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigResponseDto'
        '401':
          description: Unauthorized — invalid or missing API key / bearer token
      security:
        - api-key: []
components:
  schemas:
    WebhookConfigResponseDto:
      type: object
      properties:
        webhookUrl:
          type: object
          description: The configured webhook URL
          example: https://api.example.com/webhooks/m2m
          nullable: true
        webhookSecretPreview:
          type: string
          description: Preview of the webhook secret (masked)
          example: whsec_****abc123
        hasWebhookSecret:
          type: boolean
          description: Whether a webhook secret has been generated
          example: true
      required:
        - webhookUrl
        - webhookSecretPreview
        - hasWebhookSecret
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your partner API key. Use `raas_sandbox_*` keys for the sandbox
        environment and `raas_live_*` keys for production.

````