v1

latestOpenAPI 3.0.42026-08-042281222.0 KB

Webhooks

Update an existing webhook subscription

Updates webhook URL, events, or active status. Set RegenerateSecret=true to rotate signing secret (returned in response). Use IsActive=true to re-enable auto-disabled webhooks after fixing delivery issues. Secret only included if RegenerateSecret=true.

put/v1/Webhooks/{id}

Path parameters

idstring uuid required

Request body

urlstring uri nullable

The new HTTPS URL where webhook events will be delivered. Optional — only provide if changing the URL.

eventsstring[] nullable

Updated list of event types to subscribe to. Optional — only provide if changing the events. Note: Not supported by the ExternalCustomerAPI — that endpoint returns 400 if this field is set.

isActiveboolean nullable

Set to true to enable the webhook, false to disable it. Optional — only provide if changing the active status.

regenerateSecretboolean

Set to true to regenerate the webhook secret. A new secret will be returned in the response.

isTestModeboolean nullable

When set, updates the classification of the subscription. True maps to DataClassification.Test; false maps to DataClassification.Production. Omit to leave the current classification unchanged.

Response

Webhook updated successfully

idstring uuid

Unique identifier for the webhook subscription.

urlstring nullable

The HTTPS URL where webhook events will be delivered.

eventsstring[] nullable

Array of event types this subscription is interested in.

isActiveboolean

Whether this webhook subscription is active.

createdUtcstring date-time

Timestamp when the webhook subscription was created (UTC).

updatedUtcstring date-time

Timestamp when the webhook subscription was last updated (UTC).

disabledReasonstring nullable

Reason why the webhook was automatically disabled (if IsActive is false).

secretstring nullable

Secret key for HMAC-SHA256 signature verification. Only returned on creation or secret regeneration — never exposed again for security.

isTestModeboolean

True when the subscription has DataClassification.Test classification; false for all other classifications (Production, Demo). Computed as Classification != DataClassification.Production.