Skip to main content Skip to complementary content


Use scenarios to create a sequence of requests.

Global overview of a scenario

A scenario is an ordered set of requests that allows you to emulate a real-life usage of an API. Combined with the validation feature, it helps you ensure that the behavior is stable over time and complies with rules.

The following diagram summarizes these characteristics. It presents a chain of two requests inside a scenario, where the URI of the second request depends on the other thanks to expressions. Both requests leverage assertions in order to check the related response. They also rely on environment variables in order to configure parts of their definition.

The first request creates a contact and the second one uses data from the first request to check the existence of the newly created contact.

Request order

If you are performing tests, you might want to send your requests in a specific order. If it is your case, then all you need to do is create a scenario. Requests in scenarios can be reordered as needed. Projects and services run your requests in alphabetical order.


If you have tried running a scenario, you may have noticed green, yellow and red labels indicating its success, warning, or failure to run. This is computed for each request from the status code or via the HTTP response validation. Then the request container is tagged as success if all its children were successful.

Information noteNote: Scenarios should be functionally atomic, since unlike other containers they stop as soon as a child request fails.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!