Skip to content

Build a flow

A flow is a monitor of several steps. Use one when a single request can’t tell you a feature works: sign in, then load the orders page with the token; or check that an order in your API also reached the billing database.

This guide builds a flow that signs in to an API, lists stuck orders, and fails when there are any.

You need: an HTTP connection for your API (Connections → HTTP API) with its base URL, such as https://api.example.com, and a runner group that can reach it.

Monitors → New monitor → Check types → Flow (under Several steps). The flow editor opens: a palette of steps on the left, the canvas, and an inspector for the selected step.

Or describe the flow to Draft with ADAM in the toolbar, and review what it puts on the canvas.

Drag an HTTP step onto the canvas. In the inspector:

  • id: login
  • Connection: your API connection
  • Method POST, URL /login (relative to the connection’s base URL)
  • Keep the sign-in credentials in the connection, not in the step, so the flow holds no secret.
  • Saved values: name token, expression output.json.token

The step’s result is saved under its id (login), and token is saved as vars.token for later steps.

Add a second HTTP step and drag from the first step’s right handle to it: that sets next.

  • id: orders
  • URL /orders?status=stuck, header authorization: Bearer ${vars.token}
  • Saved values: stuck = output.json.items|length
  • Retry: up to 3 attempts, for a flaky network

Add an assert step after it:

  • Condition vars.stuck == 0
  • Message Orders are stuck

Fix anything in the problems list in the toolbar (errors block saving), then Save (⌘S). Set the flow monitor’s name, schedule and runner group, and select Run now. Each step on the canvas shows its last result; on the monitor’s page, expand the run to see every step’s output.

The saved definition:

{ "type": "flow", "value": "vars.stuck", "steps": [
{ "id": "login", "type": "http", "config": { "method": "POST", "url": "/login", "connectionId": "…" },
"outputs": [{ "name": "token", "expr": "output.json.token" }], "next": "orders" },
{ "id": "orders", "type": "http",
"config": { "url": "/orders?status=stuck", "connectionId": "…", "headers": { "authorization": "Bearer ${vars.token}" } },
"outputs": [{ "name": "stuck", "expr": "output.json.items|length" }], "retry": { "maxAttempts": 3 }, "next": "check" },
{ "id": "check", "type": "assert", "config": { "expression": "vars.stuck == 0", "message": "Orders are stuck" } } ] }

"value": "vars.stuck" records the count with every run, so a threshold rule can alert on it.

  • Branch. Drag from a step’s bottom handle to add a branch with a condition, such as output.status == 401 → a step that alerts differently. Branches are checked in order; otherwise next runs.
  • Compare across systems. A compare step checks that values from several steps agree, such as crm.json.email and billing.first.email, and fails with the values when they don’t.
  • Poll. A poll step repeats an action until a condition holds, such as waiting for an export to finish.
  • Act. An integration step can post to Slack, open a Jira issue or dispatch a GitHub workflow, for example when the check fails. Mark the step before it Continue on error so the flow goes on.
  • Undo (⌘Z), duplicate a step (⌘D), and rename steps freely: renaming rewrites the expressions that refer to them.
  • Export as tests turns the flow into a Playwright, pytest, k6 or Postman file for CI.

Every step type and field: Flow steps. Expressions: Expressions.