Starts listening for requests that match a specific URL pattern. When awaited using an await listener step, it will return the first request matching the pattern, if any.

You should register your listener before the request is made. If an action triggers the request, make sure to add this step before the action in your test.

Inputs

Request pattern
string
required

A regex pattern to match the request URL.

Listener key
string
required

A unique key to identify the listener. This key can be used in the await listener step to wait for the request to complete.

Outputs

The following outputs will be returned once the listener resolves in an await listener step:

request
Request object
required
response
Response object
required