Update Webhook
Update a webhook configuration.
Use this endpoint to:
- Update the webhook URL or description
- Disable or re-enable a webhook without deleting it
- Update which events the webhook is subscribed to
Disabled webhooks will not receive any events until re-enabled.
Authorizations
Your public API key. Identifies the partner making the request.
Monotonically increasing nonce included in the request signature.
HMAC signature over the request, computed with your private key.
Headers
Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Unique identifier for the webhook
"WHTEST-XXXXX-EXAMPLE"
Body
New HTTPS URL where webhook events will be sent. Omit to leave unchanged.
8 - 2048"https://partner.example.com/hooks/quote"
New free-form label for the webhook. Omit to leave unchanged; pass an empty string to clear.
500"primary delivery"
List of event types to subscribe to. This replaces all existing event subscriptions. Empty arrays are treated as omitted.
100quote.executed, quote.cancelled, quote.execution_failed, user.closed, user.disabled, user.verified, user.verification_failed, user.verification_needed, conversion.deposit_completed, conversion.deposit_failed, conversion.deposit_held, conversion.quote_execution_failed, conversion.withdrawal_completed, conversion.withdrawal_failed Whether the webhook should be disabled
false
Response
Webhook updated successfully