put

PUT /v2/webhooks/{id} — Update webhook

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Full update of a webhook's configuration. To toggle enabled/disabled only, use PATCH /{id}/status instead.

credentials is returned in the response only when authentication transitions from false to true in this request. If authentication was already enabled, the secret is not re-returned; use the rotate endpoint to generate a new one.

Required role

affiliate_super_admin

Request body

FieldTypeDescription
namestringHuman-readable label
urlstringHTTPS delivery endpoint
authenticationbooleanEnable or disable HMAC signing
webhookInterestsstring[]Subscribed event types (replaces the full list)

Response 200

{
  "id": "webhook::abc123",
  "name": "Order sync",
  "url": "https://api.example.com/webhooks/orders",
  "authentication": true,
  "webhookInterests": ["order_created"],
  "status": "enabled",
  "isEnabled": true
}
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!