Sign in

Rotate Webhook Endpoint Signing Secret

Rotates the signing secret for a webhook endpoint in the authenticated project.

post/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

Path parameters

webhook_endpoint_idstring required
Example:whe_123

The ID of the webhook endpoint whose signing secret will be rotated.

Request body

keep_old_secret_active_for_24_hoursboolean

Whether to keep the previous signing secret valid for 24 hours after rotation. Defaults to false, which invalidates the previous secret immediately.

Response

Success

idstring required

The unique ID of the webhook endpoint.

object'webhook_endpoint' required

The object type, which is always webhook_endpoint.

created_atinteger required

The Unix timestamp when the endpoint was created.

updated_atinteger

The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.

namestring required

The human-readable name of the endpoint.

urlstring required

The HTTPS URL that receives webhook deliveries.

event_typesstring[] required

The event types that trigger deliveries to this endpoint.

signing_secret_hintstring nullable required

A masked hint for the endpoint's signing secret.

signing_secretstring required

The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.

Changes