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

# Create webhook subscription

> Create a new webhook subscription



## OpenAPI

````yaml /openapi.yaml post /api/v2.1/webhooks/subscriptions
openapi: 3.1.0
info:
  title: Business BFF API
  version: 1.0.0
  description: Backend for Frontend - Business Panels Orchestration Layer
servers:
  - url: https://sandbox.finhub.cloud
    description: Sandbox Environment
security: []
tags:
  - name: AML
    description: Anti-Money Laundering checks and transaction monitoring
  - name: Admin - Consent Management
    description: Operations for managing consent templates and definitions
  - name: B2B Customer - Organization
    description: B2B organization registration and management
  - name: B2C Customer - Individual
    description: Individual customer registration and lifecycle management
  - name: BFF Admin - Tenant Initialization
    description: Lazy tenant initialization for fast startup
  - name: Catalog Hierarchy
    description: Hierarchical catalog management APIs
  - name: Catalog-Process Mapping
    description: APIs for catalog-process relationship management
  - name: Consent
    description: Payment consent creation and approval
  - name: Draft Management
  - name: External Events
    description: Kafka-to-HTTP bridge event ingestion and query
  - name: FinCard Virtual - Webhooks
    description: FinCard Virtual Card Webhook receiver
  - name: FinCard Virtual Account
    description: FinCard Virtual Card Account API proxy
  - name: FinCard Virtual Card Holder
    description: FinCard Virtual Card Holder API proxy
  - name: FinCard Virtual Cards
    description: FinCard Virtual Card API proxy
  - name: FinCard Virtual Common
    description: FinCard Virtual Card Common API proxy
  - name: FinCard Virtual Wallet
    description: FinCard Virtual Card Wallet API v2 proxy
  - name: FinTrans - Operations
    description: Financial transaction operations
  - name: Internal Webhooks
    description: Internal service-to-service webhook trigger (HMAC-secured)
  - name: MFE Preload
    description: MFE preload endpoints for SSR optimization
  - name: MFE Registry
    description: MFE Registry management endpoints
  - name: Payment Consent Management
    description: Operations for managing payment consents and validation
  - name: Person
    description: Person details for process context
  - name: Products
    description: Product Catalog Management API
  - name: Reference Data
    description: Shared reference data (countries, etc.)
  - name: Tenant Lifecycle
    description: Tenant mode transitions and lifecycle management
  - name: Tenant Registration
    description: Self-registration and tenant onboarding
  - name: Transfers
    description: Transfer prepare/execute aliases for muse-proxy compatibility
  - name: Verification
    description: Customer verification (KYC/KYB/AML) management
  - name: Wallet
    description: Wallet operations and balance management
  - name: Webhooks
    description: Webhook subscription and delivery management
paths:
  /api/v2.1/webhooks/subscriptions:
    post:
      tags:
        - Webhooks
      summary: Create webhook subscription
      description: Create a new webhook subscription
      parameters:
        - name: X-Tenant-ID
          in: header
          schema:
            type: string
        - name: X-User-ID
          in: header
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponseSubscriptionData'
components:
  schemas:
    CreateSubscriptionRequest:
      type: object
      properties:
        customerId:
          type: string
        subscriptionName:
          type: string
        description:
          type: string
        endpointUrl:
          type: string
        secretKey:
          type: string
        signatureAlgorithm:
          type: string
        verifySsl:
          type: boolean
        subscribedEvents:
          type: array
          items:
            type: string
        maxRetryAttempts:
          type: integer
          format: int32
        retryBackoffSeconds:
          type: integer
          format: int32
    BaseResponseSubscriptionData:
      type: object
      description: Standard API response wrapper
      properties:
        code:
          type: integer
          format: int32
          examples:
            - 200
          description: HTTP-style status code
          example: 200
        data:
          $ref: '#/components/schemas/SubscriptionData'
          type: object
          examples:
            - id: 123e4567-e89b-12d3-a456-426614174000
          description: Response payload object
          example:
            id: 123e4567-e89b-12d3-a456-426614174000
        message:
          type: string
          examples:
            - Success
          description: Result message
          example: Success
    SubscriptionData:
      type: object
      properties:
        id:
          type: string
        tenantId:
          type: string
        customerId:
          type: string
        subscriptionName:
          type: string
        description:
          type: string
        endpointUrl:
          type: string
        signatureAlgorithm:
          type: string
        verifySsl:
          type: boolean
        subscribedEvents:
          type: string
        maxRetryAttempts:
          type: integer
          format: int32
        retryBackoffSeconds:
          type: integer
          format: int32
        isActive:
          type: boolean
        lastTriggeredAt:
          type: string
        createdBy:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string

````