§ API REFERENCE

轮换 Webhook签名密钥

POST/webhook-endpoints/{subscription_id}/rotate-secretscope: webhook:manage

轮换当前 APP 订阅的签名密钥;新 signing_secret 只在本次响应返回一次。

鉴权:Authorization: Bearer <access_token>。轮换后旧密钥立即失效。
§ 1

请求信息

POST https://api.lingxiguangnian.com/api/open/v1/webhook-endpoints/{subscription_id}/rotate-secret

请求头

参数类型必填说明
AuthorizationstringBearer <access_token>。由 POST /token 换取,有效期 2 小时;api_secret 不得直连业务端点(→ 401)。

路径参数

参数类型必填说明
subscription_iduuid订阅ID。
§ 2

调用示例

curl -X POST "https://api.lingxiguangnian.com/api/open/v1/webhook-endpoints/11111111-1111-4111-8111-111111111111/rotate-secret" -H "Authorization: Bearer oat_xxxxxxxxxxxxxxxx"
§ 3

返回结果

返回字段

参数类型必填说明
id/target_url/event_types/statusmixed订阅安全投影。
signing_secretstring新 whsec_密钥,明文仅返回一次。
{ "success": true, "data": { "id": "11111111-1111-4111-8111-111111111111", "signing_secret": "whsec_new_xxxxxxxxxxxx" } }
§ 4

端点错误码

通用鉴权、scope 与限流错误见「使用概述」;下表为本端点专属错误。

HTTPerror_code触发条件
404open_api.webhook_not_found订阅不存在或不属于当前 APP/机构。
500open_api.webhook_write_failed签名密钥轮换失败。

契约真源:apps/m-master/src/app/api/open/v1/webhook-endpoints/[subscriptionId]/rotate-secret/route.ts