OpenAI API (unofficial showcase)
POST/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

Rotate Webhook Endpoint Signing Secret

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

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
webhook_endpoint_idstringrequired
The ID of the webhook endpoint whose signing secret will be rotated.
keep_old_secret_active_for_24_hoursbooleanoptional
Whether to keep the previous signing secret valid for 24 hours after rotation. Defaults to false, which invalidates the previous secret immediately.

3 status codes
200Success
idstringrequired
The unique ID of the webhook endpoint.
objectstringrequired
The object type, which is always webhook_endpoint.
Allowed:webhook_endpointDefault:webhook_endpoint
created_atintegerrequired
The Unix timestamp when the endpoint was created.
updated_atintegeroptional
The Unix timestamp of the last endpoint configuration or signing-secret change. Initialized at creation; tests and unchanged updates do not advance it.
namestringrequired
The human-readable name of the endpoint.
urlstringrequired
The HTTPS URL that receives webhook deliveries.
event_typesarray<string>required
The event types that trigger deliveries to this endpoint.
signing_secret_hintstringrequired
A masked hint for the endpoint's signing secret.
signing_secretstringrequired
The endpoint's signing secret. This is returned only when the endpoint is created or the secret is rotated.
400The request parameters are invalid.
errorobjectrequired
404The webhook endpoint was not found in the authenticated project.
errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid. A 404 is returned: The webhook endpoint was not found in the authenticated project.