Skip to main content

Create a webhook subscription

POST 
/webhooks

Creates a webhook subscription. This endpoint:

  • Registers a URL that should be called on specific events
  • Filters the subscription to specific events (deposits, credit card transactions)

Request​

Body

required

Webhook creation data

    name string
    subscribedEventTypes string[]required

    Possible values: [WEBHOOK_CREATED, WEBHOOK_UPDATED, CUSTOMER_CREATED, DEPOSIT_TRANSACTION_INITIALIZED, DEPOSIT_TRANSACTION_FAILED, DEPOSIT_TRANSACTION_SUCCEEDED, WITHDRAW_TRANSACTION_INITIALIZED, WITHDRAW_TRANSACTION_FAILED, WITHDRAW_TRANSACTION_SUCCEEDED, INTERNAL_TRANSACTION_INITIALIZED, VIRTUAL_INTERNAL_TRANSACTION_SUCCEEDED, VIRTUAL_ACCOUNT_CREATED, ASSET_TRADE_SUCCESSFUL, ASSET_TRADE_FAIL, LTV_LIQUIDATED, LTV_LIQUIDATION_WARNING, LTV_URGENT_COLLATERAL_NEEDED, LTV_COLLATERAL_NEEDED, LTV_PURCHASE_RESTRICTED, LTV_THRESHOLD_WARNING]

    url stringrequired

Responses​

Webhook subscription successfully created. Note that the signature for this webhook is included on the response payload.

Schema

    traceId string
    message string

    data

    object

    id stringrequired
    name stringrequired
    subscribedEventTypes string[]required

    Possible values: [WEBHOOK_CREATED, WEBHOOK_UPDATED, CUSTOMER_CREATED, DEPOSIT_TRANSACTION_INITIALIZED, DEPOSIT_TRANSACTION_FAILED, DEPOSIT_TRANSACTION_SUCCEEDED, WITHDRAW_TRANSACTION_INITIALIZED, WITHDRAW_TRANSACTION_FAILED, WITHDRAW_TRANSACTION_SUCCEEDED, INTERNAL_TRANSACTION_INITIALIZED, VIRTUAL_INTERNAL_TRANSACTION_SUCCEEDED, VIRTUAL_ACCOUNT_CREATED, ASSET_TRADE_SUCCESSFUL, ASSET_TRADE_FAIL, LTV_LIQUIDATED, LTV_LIQUIDATION_WARNING, LTV_URGENT_COLLATERAL_NEEDED, LTV_COLLATERAL_NEEDED, LTV_PURCHASE_RESTRICTED, LTV_THRESHOLD_WARNING]

    active booleanrequired
    url stringrequired
Loading...