ClouisleClouisle

触发器与运行

通过手动、Webhook 和定时任务启动工作流,并把运行页嵌入外部网站

触发方式在工作流设置 > 触发器 > 触发方式中配置:手动触发、Webhook、定时任务。草稿随时可以调试运行,对外触发(Webhook、嵌入、定时)都要求工作流已发布。

手动运行

在编辑器选择运行打开测试运行抽屉,填入输入参数后选择开始运行。未发布时只能选择调试(使用草稿)。

工作流发布后,用户也可以直接打开运行页填写输入并运行;运行页的呈现方式在发布时选择(表单与结果或结果与详情)。运行记录在编辑器菜单的日志页查看。

Webhook

  1. 在工作流设置 > 触发器把触发方式设为 Webhook 并保存。
  2. 保存后生成 Webhook URL;如需作废旧地址,点击重新生成,旧 URL 立即失效。
  3. 打开访问 API页,复制 Webhook URL 与页面给出的调用示例,把示例里的 YOUR_API_KEY 换成自己的 API Key。
  4. 发送请求:请求体直接提供工作流的输入字段,不要再包一层 inputs。
工作流触发器设置
工作流触发器设置

注意事项:

  • Webhook 必须已发布,且工作流的触发方式是 Webhook;否则请求会被拒绝,提示无效的 Webhook 令牌、工作流未发布或 Webhook 触发已禁用。
  • 调用需要 API Key 认证,Key 必须有权访问该工作流。Key 在用户菜单的API 密钥页创建与停用,详见API 密钥。
  • 请求立即返回一次运行记录,随后在日志页或运行抽屉查看进度和结果。
  • 包含暂停节点的工作流会在暂停点停下等待输入或审批,不会一直占用连接。

请求与响应字段的完整说明见工作流 API。

定时任务

在工作流设置 > 触发器把触发方式设为定时任务,再选择执行频率:

频率需要填写换算结果
按间隔执行执行间隔:5 / 10 / 15 / 30 分钟,1 / 2 / 3 / 6 / 12 小时*/5 * * * *、0 */2 * * * 这类表达式
每天执行执行时间分 时 * * *
每周执行星期几 + 执行时间分 时 * * 周,例如 0 9 * * 1-5 是工作日上午 9 点
每月执行日期 + 执行时间每月固定日期的执行时间
自定义 CronCron 表达式直接填写 分 时 日 月 周

定时运行使用空输入,运行记录归属于工作流创建者。

定时触发依赖部署侧的调度服务

界面保存的只是计划配置。定时触发需要部署环境开启调度服务才会按计划运行,随附的默认部署没有开启它,因此在默认部署上保存后不会自动运行。需要定时运行时,请联系部署管理员启用调度服务,并确认调度服务与界面保存的计划格式一致(否则到点仍不会触发)。排查方向见故障排查里后台任务处理相关的章节。

嵌入运行页

把已发布工作流的运行页嵌入自己的网站或内部系统:

  1. 在编辑器工具栏选择嵌入(嵌入设置)。
  2. 打开启用嵌入。工作流未发布时该开关不可用——先发布。
  3. 填写允许的域名:example.com、example.com:3000 或通配子域 *.example.com,多个用逗号或换行分隔。留空表示不限制来源域名,任何站点都能嵌入,正式环境不要留空。
  4. 按需调整展示头部、查看历史(历史记录保存在访问者浏览器本地)、允许新建,以及主题(自动/浅色/深色)和主色调。
  5. 选择浮窗、全屏或移动端嵌入模式;浮窗模式还可以设置浮窗位置(右下角/左下角)与问候语。
  6. 在API 密钥填入以 clou_ 开头的 Key,它会自动填进下方代码片段;复制代码粘贴到你的网站。
  7. 选择保存后,代码片段即可用。

注意事项:

  • 嵌入页只读已发布版本,草稿改动不会出现在嵌入页。
  • 嵌入使用 API Key 认证,Key 必须有权访问该工作流;泄露后吊销 Key 即可让嵌入失效。
  • 嵌入页的输入与结果呈现沿用发布时选择的呈现方式。完整的配置项说明、代码片段参数与鉴权细节见独立运行与网页嵌入和嵌入集成 API。

状态与取消

运行状态包括等待中、运行中、等待输入、成功、失败、已取消和超时;等待输入表示停在暂停节点等待审批或补充变量。运行抽屉可以取消仍在执行的任务;部分已发出的外部 API 请求不能被中断。

各状态的完整含义与排障顺序见工作流调试与监控。

这篇文章对你有帮助吗?

本页目录