Sign in

v2

OpenAPI 3.1.02026-07-3139137119.0 KB
webhooks

Update Webhook (partial)

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring required

Headers

Authorization-Signaturestring required

HMAC-SHA256 signature header: 'APIKey=<api_key>,signature=<hex>,timestamp=<unix_timestamp>'. The signature is computed over METHOD + path (with the /v3 prefix stripped) + timestamp.

Request body

urlstring nullable
subscription_eventsstring[]
activeboolean nullable

Example request

{
  "active": true,
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook"
}

Response

Webhook updated

idstring required
urlstring required
webhook_secretstring
subscription_eventsstring[]
activeboolean required

Example response

{
  "active": true,
  "id": "cuidjkhg3e289y74u5t6v",
  "subscription_events": [
    "ORDER_CREATED",
    "ORDER_COMPLETED"
  ],
  "url": "https://example.com/webhook",
  "webhook_secret": "whsec_xxxxx"
}