Workflows
View workflow definitions, states, and valid transitions, and set a workflow per project.
4 tools
# list_workflows
List available workflow definitions. With a project, also lists the workflows that project has customised
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| project_id | string | — | Project ID |
# get_workflow
Get a workflow definition: states in order, allowed transitions, each state's category (todo, in_progress, done), and the state new tickets start in. With a project, returns the workflow that project uses
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| name | string | — | Workflow name (default: default) |
| project_id | string | — | Project ID |
# update_workflow
Create or replace a project's workflow. The first state is where new tickets start. States that tickets are still in cannot be removed. Transition actions are not supported yet. Project lead or admin only
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| project_id | string | ● | Project ID |
| name | string | ● | Workflow name (e.g. default) |
| definition | object | ● | States, transitions, and state categories |
# reset_workflow
Return a project to the standard workflow of that name, or remove a workflow that has no standard version once no tickets use it. Project lead or admin only
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspace_id | string | ● | Workspace ID |
| project_id | string | ● | Project ID |
| name | string | ● | Workflow name (e.g. default) |