Webhook
申请创建 Webhook 端点
POST /api/webhooks/endpoints
POST
/api/webhooks/endpoints必须绑定本人已经审核通过且启用的 OAuth 或机器人应用。创建后端点处于 pending 且禁用,平台审核通过后才启用。出站事件仍由独立 signingSecret 进行 HMAC-SHA256 签名;不发送 OAuth client secret。
网站 Cookie 会话 + CSRF + 二次验证(api-token,300 秒);请在同源网站环境调用
请求体 必填
application/jsonnamestring必填去首尾空格后校验长度。
长度 ≥ 1 · 长度 ≤ 100
urlstring必填公网域名 HTTPS/443;禁止凭据、片段、IP literal、非公网 DNS 和重定向。每次投递重新验证 DNS 并固定实际连接目标。
长度 ≤ 2048 · 格式:uri
clientIdstring必填必填;本人已经审核通过且启用的 OAuth 或机器人应用 ID。Webhook 创建后进入待审并保持禁用,审核仅在创建时进行。
长度 ≥ 1
返回值
成功;无额外 data 信封。
endpointobject必填
endpointobject必填idstring必填namestring必填urlstring必填格式:uri
clientIdstring | null必填enabledboolean必填reviewStatusstring必填可选值
"pending""approved""rejected"reviewedAtstring | null必填格式:date-time
reviewNotestring必填versionstring必填格式:^[0-9]+$
createdAtstring必填格式:date-time
updatedAtstring必填格式:date-time
signingSecretstring必填仅创建或轮换时显示一次;作为 UTF-8 字符串保存到接收端私密环境,不是 OAuth client secret。
响应头
Cache-Controlstring可选可选值
"no-store"接口信息
接口: POST /api/webhooks/endpoints
operationId: createWebhookEndpoint
必须绑定本人已经审核通过且启用的 OAuth 或机器人应用。创建后端点处于 pending 且禁用,平台审核通过后才启用。出站事件仍由独立 signingSecret 进行 HMAC-SHA256 签名;不发送 OAuth client secret。
参数:
bodyname:去首尾空格后校验长度。bodyurl:公网域名 HTTPS/443;禁止凭据、片段、IP literal、非公网 DNS 和重定向。每次投递重新验证 DNS 并固定实际连接目标。bodyclientId:必填;本人已经审核通过且启用的 OAuth 或机器人应用 ID。Webhook 创建后进入待审并保持禁用,审核仅在创建时进行。