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

# Create webhook

> Creates a new webhook for event notifications



## OpenAPI

````yaml /openapi.yaml post /ramp/webhook
openapi: 3.1.0
info:
  title: FX API
  version: 1.0.0
  description: >
    API for managing FX operations including onboarding, quotes, orders, and
    customer management.

    This API provides endpoints for managing customers, bank accounts, crypto
    wallets, orders, and webhooks.
servers:
  - url: https://api.etherfuse.com
    description: Production API
  - url: https://api.sand.etherfuse.com
    description: Sandbox API (for testing)
security: []
tags:
  - name: Lookup
    description: Public endpoints for looking up stablebond and exchange rate data
  - name: Assets
    description: Get available assets for ramping
  - name: Onboarding
    description: Customer onboarding and KYC
  - name: Bank Accounts
    description: Manage customer bank accounts
  - name: Agreements
    description: Handle customer agreements and consents
  - name: Quotes
    description: Get quotes for conversions
  - name: Orders
    description: Create and manage orders
  - name: Swaps
    description: Create and manage swaps
  - name: Customers
    description: Manage customers
  - name: Crypto Wallets
    description: Manage crypto wallets
  - name: Webhooks
    description: Manage webhook subscriptions
  - name: Organizations
    description: Manage organizations and child organizations
paths:
  /ramp/webhook:
    post:
      tags:
        - Webhooks
      summary: Create webhook
      description: Creates a new webhook for event notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
      responses:
        '201':
          description: Webhook created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CreateWebhookRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Webhook ID
        eventType:
          type: string
          enum:
            - bank_account_updated
            - customer_updated
            - order_updated
            - swap_updated
            - kyc_updated
          description: Type of event to subscribe to
        url:
          type: string
          format: uri
          description: URL where webhook events will be sent
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        eventType: order_updated
        url: https://example.com/webhook
    CreateWebhookResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Webhook ID
        eventType:
          type: string
          enum:
            - bank_account_updated
            - customer_updated
            - order_updated
            - swap_updated
            - kyc_updated
          description: Type of event the webhook is subscribed to
        url:
          type: string
          format: uri
          description: URL where webhook events will be sent
        secret:
          type: string
          description: Webhook secret for signing events
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the webhook was created
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the webhook was last updated
      example:
        id: 123e4567-e89b-12d3-a456-426614174000
        eventType: order_updated
        url: https://example.com/webhook
        secret: base64_encoded_secret
        createdAt: '2024-01-01T00:00:00Z'
        updatedAt: '2024-01-01T00:00:00Z'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: Invalid request parameters
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Pass the key directly (e.g., `Authorization:
        your-api-key`). Do not use a `Bearer` prefix.

````