API REFERENCE

Workflows API

A workflow is a multi-step process definition. Starting one creates an execution that moves through its steps, some of which wait on a person — a task someone has to claim and complete. This API covers definitions, the runs they spawn, and the human tasks inside them. For single trigger-and-action rules, use the Automation API.

Definitions and templates

Manage workflow definitions through GET /workflows, POST /workflows, and the per-ID get, update, and delete. Share definitions across instances with GET /workflows/export and POST /workflows/import, or keep reusable starting points under /workflows/templates.

Executions

Kick off a run with POST /workflows/executions and steer it in flight: POST /workflows/executions/{id}/pause, /resume, /cancel, and /restart. Drive many at once with POST /workflows/executions/bulk-action. Events that a running workflow listens for are posted to POST /workflows/events.

Human tasks

When a workflow needs a person, it emits a task. Find open work with GET /workflows/tasks, take ownership with POST /workflows/tasks/{id}/claim, and finish it with POST /workflows/tasks/{id}/complete to let the run continue. Distribute a queue with POST /workflows/tasks/bulk-assign.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.

GET/api/v1/workflowsAlgaPSAList workflows (route inventory only)POST/api/v1/workflowsAlgaPSACreate workflow (route inventory only)GET/api/v1/workflows/{id}AlgaPSAGet workflow by id (route inventory only)PUT/api/v1/workflows/{id}AlgaPSAUpdate workflow (route inventory only)DELETE/api/v1/workflows/{id}AlgaPSADelete workflow by id (route inventory only)GET/api/v1/workflows/analyticsAlgaPSAGet workflow analytics (route inventory only)GET/api/v1/workflows/eventsAlgaPSAList workflow events (route inventory only)POST/api/v1/workflows/eventsAlgaPSACreate workflow event (route inventory only)GET/api/v1/workflows/events/{id}AlgaPSAGet workflow event by id (route inventory only)GET/api/v1/workflows/executionsAlgaPSAList workflow executions (route inventory only)POST/api/v1/workflows/executionsAlgaPSACreate workflow execution (route inventory only)GET/api/v1/workflows/executions/{id}AlgaPSAGet workflow execution by id (route inventory only)PUT/api/v1/workflows/executions/{id}AlgaPSAUpdate workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/cancelAlgaPSACancel workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/pauseAlgaPSAPause workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/restartAlgaPSARestart workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/resumeAlgaPSAResume workflow execution (route inventory only)POST/api/v1/workflows/executions/bulkAlgaPSABulk create workflow executions (route inventory only)POST/api/v1/workflows/executions/bulk-actionAlgaPSABulk action workflow executions (route inventory only)GET/api/v1/workflows/exportAlgaPSAExport workflows (route inventory only)POST/api/v1/workflows/importAlgaPSAImport workflows (route inventory only)GET/api/v1/workflows/searchAlgaPSASearch workflows (route inventory only)GET/api/v1/workflows/tasksAlgaPSAList workflow tasks (route inventory only)POST/api/v1/workflows/tasksAlgaPSACreate workflow task (route inventory only)GET/api/v1/workflows/tasks/{id}AlgaPSAGet workflow task by id (route inventory only)PUT/api/v1/workflows/tasks/{id}AlgaPSAUpdate workflow task (route inventory only)POST/api/v1/workflows/tasks/{id}/claimAlgaPSAClaim workflow task (route inventory only)POST/api/v1/workflows/tasks/{id}/completeAlgaPSAComplete workflow task (route inventory only)POST/api/v1/workflows/tasks/bulk-assignAlgaPSABulk assign workflow tasks (route inventory only)GET/api/v1/workflows/templatesAlgaPSAList workflow templates (route inventory only)POST/api/v1/workflows/templatesAlgaPSACreate workflow template (route inventory only)GET/api/v1/workflows/templates/{id}AlgaPSAGet workflow template by id (route inventory only)PUT/api/v1/workflows/templates/{id}AlgaPSAUpdate workflow template (route inventory only)DELETE/api/v1/workflows/templates/{id}AlgaPSADelete workflow template (route inventory only)