Skip to content

Webhook 文档

通过 Webhook 触发当前画布的工作流,并在运行历史中追踪执行状态。

请求体

Webhook 变量请求体

参数名类型必填说明
variablesobjectWebhook 变量键值对

请求体示例

json
{}

文件上传

如需传文件变量,请先调用 /openapi/files/upload 上传文件并获取 fileKey(需要 API Key),然后在 Webhook 请求体的 variables 中传 fileKey 或 fileKey[]。

查看文件上传接口文档

错误码

Webhook 与 API 集成常见错误码。

错误码HTTP 状态消息说明
CANVAS_NOT_FOUND404画布不存在关联画布不存在。
INSUFFICIENT_CREDITS402积分不足当前操作所需积分不足。
INVALID_REQUEST_BODY400请求体非法请求体格式不正确。
WEBHOOK_DISABLED403Webhook 已停用Webhook 已停用,无法触发执行。
WEBHOOK_NOT_FOUND404Webhook 不存在Webhook 不存在或已被删除。
WEBHOOK_RATE_LIMITED429Webhook 请求限流请求速率超过限制。