整合與 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。決定任務要求連接的用戶是其受託人之一或團隊所有者,因此助手可以代表您批准但不能代表其他人。