Skip to main content
Begins capturing the first request that matches. Pair with awaitListener to read the captured request/response in a later step.

Parameters

ParameterTypeRequiredDescription
substringstringNoMatch URLs that contain this substring.
globstringNoMatch URLs against a glob pattern.
regexstringNoMatch URLs against a regular expression.
domainstringNoMatch all URLs under the given domain.
keystringYesIdentifier used by awaitListener to pick up the captured request.
methodstringNoRestrict the listener to a specific HTTP method.
saveAsstringNoName of the variable to write this step’s return value to.
retriesnumberNoNumber of times to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.

Examples

- registerRequestListener:
    key: response
    regex: .+jsonplaceholder.+
- registerRequestListener:
    key: create_test
    substring: /api/tests
    method: post