跳转到文档
打开控制台
本页内容

POST /v1/webhook-endpoints

使用此 HTTP 端点文档列出的请求字段和权限。

请求示例#

curl -X POST 'https://platform.tongai.io/v1/webhook-endpoints' \  -H "Authorization: Bearer $TONG_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: 45be69f1-c266-4a09-a82c-bf3c6303eb03" \  -d '{  "url": "https://your-app.example/events",  "events": [    "operation.accepted"  ]}'
配置
curl --version

身份验证#

为自己的账户使用服务器端 API 密钥,为各客户的账户使用 OAuth。切勿将密钥放入提示词或工具参数。

webhooks:manageoperations:read

参数#

Idempotency-Keystring必填

UUID,例如 e8aa0a87-6cd9-42eb-975a-b72bf43218c8。

请求正文#

application/json
urlstring必填

格式:uri。

最大长度:2000 个字符。

eventsstring[]必填

最少项目数:1。

最多项目数:14。

响应架构#

JSON
{}

HTTP 201

application/json
object

错误与限制#

HTTP错误恢复
400无效请求REQUEST_INVALID重试前请修正错误指出的字段。
401无效凭据CREDENTIAL_INVALID检查凭据、有效期以及是否已被撤销。
402积分不足INSUFFICIENT_CREDITS为凭据所属账户充值积分,然后继续已保存的任务。
403权限被拒绝SCOPE_REQUIRED使用具有所需权限且可访问所选资源的凭据。
404资源不可用RESOURCE_UNAVAILABLE检查资源 ID,并确认其属于已授权账户。
409操作意图冲突IDEMPOTENCY_CONFLICT仅为原始请求复用意图标识。不同操作请使用新的 UUID。
429已达速率限制RATE_LIMITED等待 Retry-After 指定的时间后再重试同一请求。
503暂时不可用DEPENDENCY_UNAVAILABLE等待 Retry-After 指定时间并使用同一意图重试。超时后检查已保存的操作。