Skip to main content
PATCH
Update Webhook

Overview

Update a webhook’s URL, events, status, or description. All fields are optional - only include the fields you want to update. This endpoint requires Write scope. Omitted fields keep their current values.

Authentication

string
required
Your API key with Write scope

Path Parameters

string
required
Webhook ID (UUID)Example: 770e8400-e29b-41d4-a716-446655440000

Request Body

string
New webhook endpoint URL. It must use HTTPS and resolve to a public internet address.
array
New events to subscribe toAllowed values: order.created, order.filled, order.partially_filled, order.cancelled, order.rejected, trade.executed, deposit.completed, crypto.deposit.completed
string
Webhook statusAllowed values: active, paused, disabled
string
New description for the webhook

Request Examples

Update Events

Pause Webhook

Resume Webhook

Response

boolean
required
Indicates if the request was successful
string
required
Human-readable response message
object
required
Updated webhook object

Success Response

Error Responses

Rate Limits

  • 100 requests per minute per API key

Next Steps

Delete Webhook

Delete a webhook

Rotate Secret

Generate a new signing secret