Skip to main content
PATCH
Update webhook

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

webhook_id
string
required

Identifier returned by CreateWebhook.

Required string length: 1 - 64

Body

application/json

Request to update a webhook. Stripe-style partial PATCH: omitted fields are left unchanged.

The owning tenant is derived from the authenticated caller. Only the webhook id and the fields to mutate are supplied.

url
string

New destination URL. Omit to leave unchanged.

Required string length: 8 - 2048
description
string

New description. Omit to leave unchanged; pass empty string to clear.

Maximum string length: 500
disabled
boolean

Disable (true) or re-enable (false) deliveries. Omit to leave unchanged.

events
enum<string>[]

Replacement set of events the webhook should be subscribed to. Omit to leave unchanged. Empty arrays are treated as omitted; clearing the list is not supported (a webhook with no events cannot receive any deliveries).

Maximum array length: 100

Event type supported by the webhooks API.

Available options:
quote.executed,
quote.cancelled,
quote.execution_failed,
user.closed,
user.disabled,
conversion.deposit_completed,
conversion.deposit_failed,
conversion.deposit_held,
conversion.withdrawal_completed,
conversion.withdrawal_failed,
conversion.quote_execution_failed,
conversion.travel_rule_blocked,
transaction.swap,
transaction.price_trigger_swap,
transaction.earn_reward,
transaction.deposit,
transaction.withdrawal,
transaction.transfer,
conversion.quote_executed,
funds.deposit_received,
funds.deposit_held,
funds.deposit_credited,
funds.deposit_returned,
funds.deposit_failed,
verification.requirements_updated,
verification.updated,
price_trigger_swap.executed,
price_trigger_swap.execution_failed,
price_trigger_swap.cancelled,
price_trigger_swap.created,
price_trigger_swap.failed,
funds.withdrawal_held,
funds.withdrawal_complete,
funds.withdrawal_failed,
recurring_swap.created,
recurring_swap.executed,
recurring_swap.execution_failed,
recurring_swap.cancelled,
recurring_swap.failed,
recurring_swap.paused,
recurring_swap.resumed,
transaction.recurring_swap

Response

Successful response

data
Webhook · object
required

A registered webhook destination.