Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Rotate Webhook Endpoint Signing Secret

$ openai webhooks rotate-secret
POST
/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

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

Rotate Webhook Endpoint Signing Secret

openai webhooks rotate-secret \
  --api-key 'My API Key' \
  --webhook-endpoint-id whe_123
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}
Parameters
--webhook-endpoint-id: string

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

--keep-old-secret-active-for-24-hours: optional boolean

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

Returns
webhook_endpoint_with_secret: object { id, created_at, event_types, 6 more }
id: string

The unique ID of the webhook endpoint.

created_at: number

The Unix timestamp when the endpoint was created.

event_types: array of string

The event types that trigger deliveries to this endpoint.

name: string

The human-readable name of the endpoint.

object: "webhook_endpoint"

The object type, which is always webhook_endpoint.

signing_secret: string

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

signing_secret_hint: string

A masked hint for the endpoint’s signing secret.

url: string

The HTTPS URL that receives webhook deliveries.

updated_at: optional number

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

Returns Examples
200 — Example
{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "name",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}