Register request listener

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

URL Matcher

object

Show child attributes

Substring
Glob
Regex
Domain

url

string

required

The substring to look for

HTTP Method

Only match requests that have this HTTP Method

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

Show properties

url

string

required

The URL of the request that matched the pattern.

method

string

required

The HTTP method of the request (e.g., GET, POST).

headers

object

required

A key-value object containing the request headers.

json

object

The JSON body of the request. This will be undefined if the content-type is not JSON.

text

string

The raw body of the request. This will be undefined if the content-type is not text.

response

Response object

required

Show properties

status

number

required

The HTTP status code of the response.

headers

object

required

A key-value object containing the response headers.

json

object

The JSON body of the response. This will be undefined if the content-type is not JSON.

text

string

The raw body of the response. This will be undefined if the content-type is not text.

AI steps

Primitive steps

Advanced steps

Register request listener

Inputs

Outputs

AI steps

Primitive steps

Advanced steps

​Inputs

​Outputs

Inputs

Outputs