Product documentation
Updated February 5, 2026

Understanding Workflows

Workflows let you chain multiple API calls into end-to-end scenarios—model real journeys, pass data between steps, and validate multi-step business processes.

Overview

Workflows are end-to-end integration tests: they chain multiple API calls into a single scenario (auth → business actions → validation → cleanup). They’re ideal when a single endpoint test is not enough to validate real behavior.

Who should use workflows

  • QA teams testing complete business scenarios
  • automation engineers validating multi-service interactions
  • DevOps teams running CI regression pipelines

How workflows are built

Workflows are typically composed of:

  • a start node (entry point)
  • one or more API request steps
  • variable capture and data passing between steps
  • validations (status code, schema, key fields, timing)
  • a stop node (final outcome)

Example data passing:

access_token from login → used in Authorization header for the next request

Running workflows

You can execute workflows:

  • from the workflows list
  • from inside the builder
  • on a schedule (if enabled)
  • via CI/CD integration (where supported)

Best practices

  • Keep workflows modular and reusable.
  • Prefer variables over hardcoded values (especially tokens and IDs).
  • Add assertions at each critical step so failures are localized.
  • Keep cleanup steps explicit to avoid data pollution.

Next steps

Still stuck?

Tell us what you’re trying to accomplish and we’ll point you to the right setup—installation, auth, or CI/CD wiring.

Email supportBook Demo