API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rotate Webhook Endpoint Signing Secret

webhooks.rotate_secret(strwebhook_endpoint_id, WebhookRotateSecretParams**kwargs) -> WebhookEndpointWithSecret

POST/webhook_endpoints/{webhook_endpoint_id}/rotate_secret

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

ParametersExpand Collapse

webhook_endpoint_id: str

keep_old_secret_active_for_24_hours: Optional[bool]

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

ReturnsExpand Collapse

class WebhookEndpointWithSecret: …

id: str

The unique ID of the webhook endpoint.

created_at: int

The Unix timestamp when the endpoint was created.

formatunixtime

event_types: List[str]

The event types that trigger deliveries to this endpoint.

name: str

The human-readable name of the endpoint.

object: Literal["webhook_endpoint"]

The object type, which is always webhook_endpoint.

signing_secret: str

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

signing_secret_hint: Optional[str]

A masked hint for the endpoint’s signing secret.

url: str

The HTTPS URL that receives webhook deliveries.

updated_at: Optional[int]

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

formatunixtime

Rotate Webhook Endpoint Signing Secret

Python

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
webhook_endpoint_with_secret = client.webhooks.rotate_secret(
    webhook_endpoint_id="whe_123",
)
print(webhook_endpoint_with_secret.id)

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
}

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
}