Workflow steps

A workflow step represents a single stage in a workflow that items—stories and bugs—move through as they progress from start to finish. Workflow steps are used in both team workflows and shared areas such as Story refinement and Bug triage. Each step defines where an item is in its current workflow and whether it’s applicable to stories, bugs, or both.

Workflow steps are most commonly returned as related resources when you request stories or bugs with ?include=WORKFLOW_STEP. This topic describes the shape of the workflow_step object in those responses, as well as the response from the Get a workflow step endpoint.

Workflow attributes

Field	Type	Description
`name`	string	The name of the workflow step.
`category`	enum	All workflow steps are organized into four categories, which makes it possible to compare customized workflows across different teams. The category of a workflow step determines the general stage of work items in the step. Valid values include `TODO` (To do), `IN_PROGRESS` (In progress), `DONE` (Done), and `WONT_DO` (Won't do).
`position`	int32	The step's position within its category. Steps are ordered by category first, then by position within that category.
`color`	string	The hexadecimal color code associated with the workflow step for visual representation in the Atono application (for example, `966bec`).
`stepType`	enum	The high-level classification of the workflow step (for example, `DESIGN`, `DEVELOPMENT`, `REVIEW`). Used to determine the default color if no custom color is set, and to help Atono choose where to move items when a step is deleted or the workflow is reset.
`forStory`	boolean	Indicates whether stories can be assigned to this step (`true`) or not (`false`).
`forBug`	boolean	Indicates whether bugs can be assigned to this step (`true`) or not (`false`).
`allNewItems`	boolean	Indicates whether new backlog items can be created directly in this step (`true`) or not (`false`).

Example: Get a workflow step

This example shows a GET response for a single workflow step, including its ID, display attributes, and configuration options for stories and bugs.

{
  "data": {
    "type": "workflow_step",
    "id": "014806ef-a67c-4835-b80c-e75683044c07",
    "attributes": {
      "name": "Review",
      "category": "IN_PROGRESS",
      "position": 2,
      "color": "966bec",
      "stepType": "REVIEW",
      "forStory": true,
      "forBug": true,
      "allowNewItems": true
    }
  },
  "links": {
    "self": "/api/v1/workflow-steps/014806ef-a67c-4835-b80c-e75683044c07"
  }
}