Management
Rotate a webhook endpoint's signing secret
Experimental. This endpoint is still settling — its request and response shape may change without a deprecation cycle.
Replaces the endpoint's signing secret and returns the new one, the only time it is shown. The new secret signs the next attempt to the endpoint, retries included, so update the consumer first if it verifies signatures.
/management/webhooks/{webhookEndpointReference}/rotate-secretAuthorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
webhookEndpointReferencestringrequiredWebhook endpoint reference, as returned by GET /management/webhooks.
Responses
200The endpoint, with its new signing secretapplication/jsonShow response bodyHide response body
dataobjectrequiredShow propertiesHide properties
webhookEndpointReferencestringrequiredIdentifies the endpoint in GET /management/webhooks/{webhookEndpointReference}/deliveries.
urlstring · urirequiredDestination Firsty posts events to.
eventTypesarray of stringrequiredEvent types delivered to this endpoint. Values this client subscribed to before an event type was retired are returned as stored, so an entry may be absent from GET /catalog/webhook-event-types.
descriptionstring | nullrequiredFree-text label for the endpoint.
activebooleanrequiredWhether events are delivered to this endpoint.
createdAtstring · date-timerequiredupdatedAtstring · date-timerequiredsigningSecretstringrequiredKey that signs every delivery to this endpoint. Returned only by create and rotate-secret.
401Unauthorized - missing or invalid API key404Resource not found429Rate limit exceeded500Internal server error