Skip to main content

Flows

Flows are automated sequences of API calls for testing and validation. Build multi-step test scenarios that chain requests, pass data between steps, and assert on responses.

Creating a Flow​

  1. Navigate to Flows in the sidebar
  2. Click New Flow
  3. Give your flow a name and optional description

Flow Steps​

Each step in a flow represents an API call:

Request Configuration​

  • Target - Simulation URL + route path
  • Method - HTTP method
  • Headers - Including authentication
  • Body - Request payload with variable substitution

Variable Extraction​

Extract values from responses for use in subsequent steps:

Set {{userId}} = response.body.data.id
Set {{authToken}} = response.headers.authorization

Assertions​

Validate response behavior:

Assert status == 201
Assert body.data.name == "Alice"
Assert header.content-type contains "application/json"
Assert responseTime < 500

Control Flow​

  • Conditional steps - Execute only if a condition is met
  • Loops - Repeat a step N times or until a condition
  • Delays - Wait between steps

Running Flows​

  • Manual run - Execute from the UI with real-time output
  • Scheduled - Run on a cron schedule
  • CI/CD - Trigger via API or CLI

Flow Results​

After execution, view:

  • Step-by-step pass/fail status
  • Request/response details for each step
  • Assertion results
  • Total execution time
  • Variable values at each step

Next Steps​