集成和 API
标签页
追踪器显示的所有内容也可供其他系统使用:随着运行的移动,webhooks 会触发,REST API 读取运行并对任务进行操作,MCP 服务器向 AI 助手公开相同内容。
Webhooks
在 API 和 webhooks 下添加事件 Workflow 的 webhook。它接收团队的每个工作流,或者当您选择一个表单时,只接收使用该表单的工作流。每个调用都包含事件名称、运行以及(如果有)任务及其提交 ID:
| 事件 | 何时 |
|---|---|
workflow.run.started |
启动表单已提交。 |
workflow.run.restarted |
被拒绝的运行从 重新开始 按钮再次启动。 |
workflow.task.created |
一步被分配给某人。 |
workflow.task.completed |
表单步骤已提交。 |
workflow.task.decided |
批准已决定;有效负载包含结果和评论。 |
workflow.run.completed |
每个路径都已完成。 |
workflow.run.rejected |
退回结束了运行。 |
workflow.run.cancelled |
有人在追踪器中或通过 API 取消了运行。 |
单个表单上的表单级 webhook 在提交时继续触发。
REST API
API v4 对运行和任务具有读写访问权限。所有路由都位于 /api/v4/ 下:
| 方法和路由 | 功能 |
|---|---|
GET workflow/<workflow>/definition/ |
工作流的步骤和连接,只读。 |
GET workflow/<workflow>/runs/ |
工作流的运行,可按状态、受让人和逾期进行过滤,分页。 |
GET workflow/run/<run>/ |
一个运行及其任务和时间线。 |
GET workflow/run/<run>/final-pdf/ |
完成的 PDF 的限时链接,当有批准记录页面时包含该页面。 |
POST workflow/run/<run>/cancel/ |
取消运行,可选择提供原因。 |
GET workflow/tasks/ |
跨工作流的任务,可按受让人邮箱和状态过滤,适用于收件箱风格的客户端。 |
POST workflow/task/<task>/decide/ |
决定一个批准任务:结果和评论。 |
POST workflow/task/<task>/nudge/ |
重新发送任务的电子邮件。 |
POST workflow/task/<task>/reassign/ |
将任务交给一个电子邮件地址或团队成员。 |
用于提交工作流步骤和按步骤列出工作流提交的旧路由保持不变。
MCP 工具
PlatoForms MCP 服务器 为 AI 助手提供相同的视图:list_workflow_runs(按工作流、状态或逾期)、get_workflow_run、list_my_workflow_tasks、decide_workflow_task 和 nudge_workflow_task。决定任务要求连接的用户是其受让人之一或团队所有者,因此助手可以代表您批准,但不能代表其他人。