Skip to main content
POST
触发自动化 webhook
使用此端点运行一个配置为 Webhook 触发器的自定义自动化。每次请求会将一次运行加入队列,该运行使用自动化保存的 prompt 并读取仓库的完整历史记录。请求体会被忽略。 此端点仅支持配置了 webhook 触发器的自定义自动化。预定义自动化以及使用其他任何触发器的自动化都会返回 404 响应。若要按需触发一个计划型自定义自动化,请改用触发自动化

用例

  • CI/CD 流水线:在每次合并到 main 或发布之后运行自定义自动化,无需等待计划运行。
  • 发布事件:在打出标签或发布新 SDK 版本时,从发布脚本运行自定义自动化。
  • 内部工具:从内部仪表板、Slack 命令或已有的计划任务中触发自动化。

获取 webhook URL 和身份验证请求头

在控制台中打开自动化页面,点击具有 webhook 触发器的自定义自动化上的 设置按钮。触发器卡片会显示完整的 webhook URL,以及用于 Authorization: Bearer <api-key> 请求头模板的 Copy auth header 操作。 <api-key> 替换为具有写入权限且未过期的组织 API 密钥。在 API keys 页面创建或管理密钥。自动化不会为你创建、存储或轮换密钥。

示例

每当代码合并到 main 时,从 GitHub Action 触发一个 webhook 自动化:
.github/workflows/trigger-docs.yml

速率限制

此端点与触发更新触发自动化共享速率限制:每个组织每 10 秒最多 10 次请求。每次入队运行消耗的额度与其他任何自定义自动化运行相同。请参见额度定价

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

路径参数

projectId
string
必填

你的项目 ID。可以从控制台的 API keys 页面复制。

workflowSchemaId
string
必填

要触发的自动化的 ID。可以从控制台自动化页面上该自动化的设置面板复制。

响应

自动化运行已成功加入队列。

success
boolean
runId
string

已排队的自动化运行的 ID。会出现在自动化页面的运行历史中。