Introduction

The Postman Integration can be used to run a Postman collection. You can find the Postman integration in the "Checks" folder in the experiment editor.

Details

Currently, we are supporting collections, which are hosted and accessible via Postman's Cloud API service.

We are using newman to run your collection behind the scenes.

References

• Blog post Harden Your API by Adding Chaos Engineering to Your Tests

Configuration

To configure the Postman integration, you need to provide an API-Key. This can be created here.

Target

You have to specify the collection to run as target. The collections will be discovered by the extension.

Parameters

Name	Required	Description
Estimated duration	Yes	As long as you have no timeout in place, the step will run as long as needed. You can set this estimation to size the step in the experiment editor for a better understanding of the time schedule.
Environment Id or Name	No	The environment id or name to use. You can put the environment name here or find out your environment id by fetching all environments from the postman api with https://api.getpostman.com/environments?apikey=$apiKey
Environment Variables	No	Additional environment variables, will be passed to newman with --env-var key=value
Iterations	No	Number of iterations to run the collection, will be passed to newman with -n
Timeout	No	The timeout of your collection, wil be passed to newman with --timeout. Hint: If you hit this timeout, no reports will be generated.
Request Timeout	No	The request timeout for each request, wil be passed to newman with --timeout-request
Verbose	No	Should we enable verbose logging? Will be passed to newman with --verbose
Bail	No	Stops the runner when a test case fails. Will be passed to newman with --bail

Outputs

We are using the reporters cli, json-summary and htmlextra.

You can download the json-summary and htmlextra -report in the experiment run log after the experiment has finished. We omit the response bodies in the htmlextra-report.

The cli-output can be accessed by clicking on the Action Logs-tab in the experiment run view and supports a live view during experiment execution.

The step will be marked as failed, if implemented tests in the postman collection are failing.