v1

latestOpenAPI 3.1.02026-07-1325128129.5 KB

webhooks

Update Webhook

Update an existing webhook for the authenticated organization

put/webhooks/{webhook_id}

Path parameters

webhook_idstring required

The unique identifier of the webhook

Headers

Authorization-Signaturestring required

Authorization header format: 'APIKey=<api_key>,signature=<signature>,timestamp=<unix_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 successfully

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"
}