Guides

Recipes (automated tests)

Chain multiple endpoints into a repeatable test with assertions and variables.

Updated

A recipe is a multi-step automated test. Each step is one HTTP request with assertions on the response; values from one step’s response can be passed into the next step’s request via variables. Use recipes to encode flows like “create a user → log in → fetch profile → update preferences” and run them on demand.

When recipes are useful

  • Smoke tests before pointing the team at a new staging deploy.
  • Integration flows that span multiple endpoints and care about state.
  • Reproducing bugs — capture the exact sequence so anyone can re-run it.
  • Pre-flight checks for breaking-change reviews.

Building a recipe

Open Recipes in the workspace nav, click New recipe:

  1. Give it a name and (optional) description.
  2. Add steps — pick an endpoint from your spec, fill the parameters, attach auth.
  3. Add assertions per step — status code, response header, body field equals / contains / matches regex, max latency.
  4. Define variables — name + initial value. Reference them in any step’s parameters or body with {{variable}}.
  5. Capture from a response with Mappings — body.user.id → user_id makes that value available in later steps as {{user_id}}.
  6. Optional: set an Ending action — run a cleanup endpoint when the recipe finishes (e.g. delete the test user).

Running

Click Run on the recipe detail page. Each step:

  • Sends the request through our server-side proxy.
  • Captures status, headers, body, latency.
  • Evaluates assertions.
  • Stops or continues based on the step’s on_failure policy (stop / skip / mark-failed-and-continue).

Failed steps are highlighted with the violated assertion. Latency is visualised per step so slow steps stand out.

Run history

The History tab on the recipe shows every run with its outcome, total duration, and a step-by-step replay. Runs are retained for 30 days. Shareable URLs let you link teammates straight to a specific run.

Slack notifications

If your workspace has Slack connected, recipe failures (assertion fail, timeout, non-2xx) post to your configured channel automatically. See Connect Slack.

Limits

  • Up to 15 minutes per run; longer runs are auto-cancelled.
  • A recipe holds up to 50 steps.
  • Variable count is unlimited but each step’s payload size cap is 1 MB.