OpenAI 轮换Webhook端点签名密钥

轮换 Webhook 端点签名密钥

post /webhook_endpoints/{webhook_endpoint_id}/rotate_secret

轮换当前身份验证所对应项目中某个 Webhook 端点的签名密钥。

路径参数

• webhook_endpoint_id: string

要轮换签名密钥的 Webhook 端点的 ID。

请求体参数

内容类型：application/json

• keep_old_secret_active_for_24_hours: optional boolean

是否在轮换后让先前的签名密钥继续有效24小时。默认为 false，即立即使先前的密钥失效。

返回值

• WebhookEndpointWithSecret object { id, created_at, event_types, 6 more }

• id: string

Webhook 端点的唯一 ID。

• created_at: integer

端点创建时的 Unix 时间戳。

format: unixtime

• event_types: array of string

触发向此端点投递的事件类型。

• name: string

端点便于阅读的名称。

• object: "webhook_endpoint" (default: "webhook_endpoint")

对象类型，始终为 webhook_endpoint。

• "webhook_endpoint"

• signing_secret: string

端点的签名密钥。仅在创建端点或轮换密钥时返回。

• signing_secret_hint: string or null

端点签名密钥的掩码提示。

• url: string

接收 Webhook 投递的 HTTPS URL。

• updated_at: optional integer

上次更改端点配置或签名密钥时的 Unix 时间戳。创建时初始化；测试以及未改变配置的更新不会推进此时间戳。

format: unixtime

示例

## 从环境变量读取 API 密钥；运行前替换 Webhook 端点 ID、URL 和名称占位值。
curl https://api.openai.com/v1/webhook_endpoints/$WEBHOOK_ENDPOINT_ID/rotate_secret \
    -X POST \
    -H "Authorization: Bearer $OPENAI_API_KEY"

200：示例

{
  "id": "id",
  "created_at": 0,
  "event_types": [
    "string"
  ],
  "name": "示例端点",
  "object": "webhook_endpoint",
  "signing_secret": "signing_secret",
  "signing_secret_hint": "signing_secret_hint",
  "url": "url",
  "updated_at": 0
}