Skip to main content

Scripts request reference

These helper functions are available in the request object in scripts.

request.variables.get​

Get a request variable.

Request variables are only available for the duration of the request.

client.log(request.variables.get("SOME_TOKEN"));

request.variables.set​

Set a request variable.

Request variables are only available for the duration of the request.

request.variables.set("SOME_TOKEN, "123");
client.log(request.variables.get("SOME_TOKEN"));

request.body.getRaw​

Returns the request body string in the raw format (or undefined if there is no body).

If the body contains variables, their names are displayed instead of their values. For example:

client.log(request.body.getRaw());

request.body.tryGetSubstituted​

Returns the request body with variables substituted (or undefined if there is no body).

client.log(request.body.tryGetSubstituted());

request.body.getComputed​

Returns the string request body as sent via curl; with variables substituted, or undefined if there is no body.

tip

Useful if you want to see the request body as it was sent to the server.

The tryGetSubstituted method will substitute variables with their values, but leave the rest of the body as is.

If you have a GraphQL query in the body, for example, the getComputed method will show the query as it was sent to the server, which is quite different from the substituted version.

As an example, if you have a request body like this:

query getRestClient($name: String!) {
  restclient(name: $name) {
    id
    name
    editorsSupported {
      name
    }
  }
}

{
  "variables": {
    "name": "{{ENV_VAR_CLIENT_NAME}}"
  }
}

Then the getComputed method will return the body as it was sent to the server:

{"query": "query getRestClient($name: String!) { restclient(name: $name) { id name editorsSupported { name } } } ", "variables": {"variables": {"name": "kulala"}}}

whereas the tryGetSubstituted method will return the body with variables substituted as seen in your script:

query getRestClient($name: String!) {
  restclient(name: $name) {
    id
    name
    editorsSupported {
      name
    }
  }
}

{
  "variables": {
    "name": "kulala"
  }
}
warning

The getComputed method is always undefined for binary bodies.

request.environment.get​

Retrieves a value of the environment variable identified by its name or returns null if it doesn't exist.

client.log(request.environment.get("SOME_ENV_VAR"));

request.headers.all​

Returns all request header objects.

Each header object has the following methods:

  • name() - Returns the name of the header.
  • getRawValue() - Returns the value of the header in the raw format.
  • tryGetSubstituted() - Returns the value of the header with variables substituted.
const headers = request.headers.all();
for (const header of headers) {
  client.log(header.name());
  client.log(header.getRawValue());
  client.log(header.tryGetSubstituted());
}

request.headers.findByName​

Returns a request header object identified by its name.

The header object has the following methods:

  • name() - Returns the name of the header.
  • getRawValue() - Returns the value of the header in the raw format.
  • tryGetSubstituted() - Returns the value of the header with variables substituted.
const contentTypeHeader = request.headers.findByName("Content-Type");
if (contentTypeHeader) {
  client.log(contentTypeHeader.name());
  client.log(contentTypeHeader.getRawValue());
  client.log(contentTypeHeader.tryGetSubstituted());
}

request.method​

Returns the request method.

Such as GET, POST, PUT, DELETE, etc.

client.log(request.method());

request.url.getRaw​

Returns the request URL in the raw format, without any substitutions.

client.log(request.url.getRaw());

request.url.tryGetSubstituted​

Returns the request URL with variables substituted.

client.log(request.url.tryGetSubstituted());