返回文档
Hooks

为工作流事件配置 Hooks

先明确 Hook 在什么事件上触发,再定义它能读取什么上下文、能执行哪些动作,以及如何安全上线。

更新于: 2026-04-12阅读时长: 6 分钟
文档来源
Release 文档 v1.0.0
文档版本: v1.0.0

Hook 的作用

Hook 用于在指定工作流事件发生时自动执行额外步骤。常见用途包括校验、格式整理、通知、路由和后处理。

如果某个动作会在每次任务前后重复出现,就适合优先考虑用 Hook 处理。

触发点

配置 Hook 前,应先明确它是在以下哪类事件上触发:

  • 任务开始前
  • 任务输出生成后
  • 执行发布动作时
  • 任务状态变化时

输入与输出

每个 Hook 至少要定义清楚以下内容:

  • 由什么事件触发
  • 可以读取哪些上下文
  • 允许产生哪些副作用
  • 失败后如何处理

上线建议

先从容易验证、容易关闭的 Hook 开始。每次修改后先检查输出和日志,再逐步接入更长的自动化链路。正式环境中,不建议一次性启用过多串联 Hook。