跳转到主要内容
POST
配置 Webhook

配置 Webhook

设置账户的 Webhook URL。每个账户一个 URL,两种事件都发送到该地址。
API 密钥无法调用此接口。 修改 Webhook URL——以及读取签名密钥——都需要您本人在网站上开启的会话。使用 API 密钥时请求会被拒绝:
Response
否则,一把被盗的密钥就足以把您的事件指向他人的服务器。请在 Dashboard → API 中设置 URL;同一页面也会显示签名密钥。

请求体

string
必填
Webhook URL。此接口仅接受 HTTPS,且不得指向 localhost、127.0.0.1、0.0.0.0 或 ::1。此外,发送时若主机解析到私有、回环或链路本地地址,投递同样会被拒绝。

响应

string
当前配置的 URL。
string
用于 X-Webhook-Signature 的签名密钥。在账户首次设置 URL 时生成,之后保持不变。
Response

后台入口

后台使用另一对接口操作同样的账户级字段——GET /api/v1/account/webhook 读取 URL 和密钥,PATCH /api/v1/account/webhook 设置或清除。两者接受相同的值,但有两点不同:PATCH 还允许 http:// 地址,发送 {"webhook_url": null} 可清除 Webhook。 清除 URL 会保留密钥,因此日后重新启用 Webhook 不会使您已部署的校验代码失效。 这两个接口同样需要网站会话。