Docs Automation

Flows (request orchestration)

A flow runs requests as a diagram: each request is a node, connections set the order, values pass from one request to the next, and conditions choose which way to go. Open Flows in the sidebar and click +. A new flow starts as Start → Request → End.

Nodes

  • Start: where the flow begins. Its inputs become values such as {{user}}. Variables are allowed.
  • Execute: sends a saved request. Its auth, scripts and auth dependency (automatic login) work as when you send it yourself. Outputs take values from the response for later nodes: name token, path data.access_token. A path is status, time, headers.Name, or a path in the JSON body (items[0].id). Later nodes use it as {{login.token}}, where login is the node's key from its label, shown on the node. {{login.status}} and {{login.time}} are always there. A failed request stops the flow unless Carry on when the request fails is ticked.
  • Condition: compares values with rules, such as {{login.status}} equals 200 or {{orders.total}} greater than 0. It goes on through its green true port when all rules match, or when any one does, as you choose; otherwise through its red false port. The rules can be equals, not equals, contains, not contains, greater than, less than, exists, not exists or matches (a regular expression).
  • End: where the flow ends. Result tabs pick what to show. For each tab, choose a node and the path to the part of its response to show, such as data.items. It's shown as a table that can be filtered, sorted and exported, the same as the response Table view. Outputs are named results built from values.

Designing

  • Moving and connecting: drag a node by its title. Drag from a node's right-hand dot to another node to connect them. A condition has one connection per port.
  • Adding nodes: Add Execute / Condition / End puts the new node after the selected one and connects it.
  • Removing: click a node or connection, then press Delete. Start can't be removed.
  • Zooming: use −, + and Fit (or Ctrl/Cmd+scroll). A flow opens zoomed to fit.
  • Copying values: the side panel lists the values the flow makes; click one to copy it.
  • Collapsing nodes: a node's chevron, or a double-click on its title, folds it to its title bar. Its connections stay, and hovering shows its summary. The − button in the toolbar collapses or expands every node.
  • Hiding and resizing panels: the toolbar buttons hide or show the side panel and the results, so the canvas can fill the tab. Drag the bar above the results to resize them.

Running

  • Order: a node runs once everything before it has run, so a node with two connections in waits for both. The branch a condition doesn't take is skipped, along with everything that only follows from it. Loops aren't allowed.
  • During a run: each node shows its state as it goes (✓ done, ✕ failed, faded when skipped), and the connections taken are highlighted.
  • Results: the End node's result tabs come first, then Outputs, then Values (every value the flow made), then one tab per request with its status, time, tests and response as a table.
  • Environment and variables: a flow uses the active environment or the one chosen in its settings. Like the Runner, it can keep variable changes made during the run, such as refreshed tokens. Requests can come from different collections; each uses its own collection's variables.

Flows are saved in your workspace.

Edit this page on GitHub