Update a Webhook Subscription
POST …/webhook/subscription/ — Partially updates a webhook subscription. Only supplied fields change; omitted fields keep current values.
null) retains its current value. At least one field must be provided. You can use this endpoint to change the callback URL, update the event list, toggle the subscription on or off, or update the description.
POST (not PUT) for this update operation. Use the path POST /public/webhook/subscription/{SubscriptionId}.Authorizations
Portal application identifier used as part of HMAC-authenticated API requests.
Portal user API key used together with the HMAC signature headers.
Timestamp header included in the signed request to prevent replay attacks.
HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.
Headers
Accept Header
application/json Path Parameters
Numeric ID of the webhook subscription to update. Must belong to the authenticated account; returns 400 if not found.
Body
Webhook Services
New HTTPS URL for the webhook endpoint. Must use the https:// scheme and resolve to a publicly routable host — private, loopback, and link-local addresses are rejected. Omit (null) to keep the current URL.
New human-readable label for this subscription. Send an empty string to clear the current description. Omit (null) to keep the current value. Trimmed before storage.
When false, the subscription is paused and no events will be delivered until re-enabled. Omit to leave the current state unchanged.
Replacement list of event-type names. When provided, completely replaces the existing event list. Omit to leave the current list unchanged.
Response
Success
Webhook subscription returned by the public webhook management API
Unique numeric identifier of the webhook subscription
HTTPS URL that receives webhook POST deliveries
Whether the subscription is enabled
Event names that trigger this subscription
Optional human-readable label for the subscription
Signing secret used to verify webhook deliveries. Returned on create and update responses only; omitted from list responses.