Skip to main content
You can use the require method to import preloaded libraries or global helpers directly inside your Requestly Script Tab in API Client requests. The script environment supports JavaScript-based transformations, validations, and dynamic request logic for HTTP and GraphQL APIs.

require

The require method lets you import supported modules into your script. Declare the result as a variable to access functions or objects from that module.

Syntax

If the module provides functions or objects, assign it to a variable as shown above.

Example

Use Global Objects

Requestly script sandbox provides several global variables and utilities you can access directly.

Available Globals

Use External Libraries

The require method enables you to use preloaded libraries in the Requestly script environment. All supported modules are sandboxed for safe execution.

Supported Libraries

The following external libraries are available:

Call uuid and csv-parse as functions

require('uuid') and require('csv-parse/lib/sync') can each be called directly. Their named members work as well, such as uuid.v4(), uuid.validate() and const { parse } = require('csv-parse/lib/sync').
csv-parse options take the names csv-parse version 5 uses, as listed in the csv-parse documentation. The older names auto_parse, auto_parse_date, rowDelimiter and relax are accepted too. A row with a different number of columns than the first is dropped when it is the last row and is an error anywhere else.

Install a package from npm

You are not limited to the libraries above. On the desktop app, require() any package from npm and Requestly installs it when the request is sent:
Search for and manage installed packages from the Package Library.
npm packages and Custom Packages are desktop-only. On the web app, require() resolves the built-in libraries listed above but has no user-package tier.

If your organization restricts external packages

An organization Owner or Admin can limit which external packages scripts may import, or block them entirely, from Settings > Organization > Resources. Where a package is not permitted, installing it is refused and a script that requires it is blocked when the request runs, with a message naming the package. Requestly’s built-in libraries are exempt and always resolve. See Organization resources.

Require your own code as a package

To reuse a helper across requests without repeating it, author it in the Package Library and require it by name with a .js suffix:
A Custom Package belongs to the project it was created in. To use one in another project, export it and import it there.

How a Custom Package loads

A Custom Package is a CommonJS module. Set module.exports, or add to exports:
  • module. Inside the package, module.id is the package name, and module.exports is the same object as exports until you replace it. require() always returns what module.exports is at that moment.
  • One run per script. The package runs the first time a script requires it. Requiring it again in the same script returns the same exports without running it again. The next script gets a fresh copy, so a variable declared in the package starts over.
  • A package that fails. If the package throws while it loads, the error reads Error in package 'signing-helpers': <message>. In the current desktop app the package stays as far as it got, so requiring it again in the same script returns what it had exported and does not run it again. A package that does not exist throws Cannot find package 'signing-helpers'.
  • Packages that use each other. A package can require other packages, and itself. If two packages require each other, the one that is asked for while it is still loading returns the exports it has set so far.
  • What a package sees. A package can use rq, console, fetch, the timer functions, require(), and variables a script assigned without a keyword (auth = 'abc';). It does not see the old global names (environment, tests, responseBody and so on), requestly, _, CryptoJS or xml2Json: each reads as undefined there. Load a library with require() instead. require.cache is not available.
  • Packages from npm. A package you installed from npm does not see rq: it reads as undefined. Pass the values it needs as arguments.
To share a helper only between the scripts of a single run — a collection-level script and the requests beneath it — you do not need a package at all. See Sharing code between scripts.
Example

Use Built-in Globals

Requestly also provides a few helper functions and contextual variables for working with request and response data.

Examples

  • xml2Json does not throw on text that is not valid XML. It writes the warning xml2Json could not parse the XML. to the DevTools Console, so check the Console when a script that converts XML fails on a later line.
  • JSON.parse ignores a byte-order mark at the start of the text (UTF-8, or UTF-16 in either byte order), so text from a server that writes one parses the same as text without it.

Notes

  • A set of Node.js built-in modules is also available via require(). In Safe mode, the default, these resolve: assert, buffer, crypto, events, path, punycode, querystring, stream, string_decoder, timers, url, util and zlib. path is the browser version: it has no posix or win32, and resolve() starts from /.
  • In Safe mode, fs loads as an empty object and os as a neutral stand-in, so a library that requires them still loads, but neither reaches your machine. Modules that need a network socket or a child process (net, child_process) are never available.
  • The built-in libraries need no installation or internet access; they are pre-bundled. Packages you install from npm are fetched once, then cached.
  • The sandbox is isolated for security: require() cannot reach system-level Node APIs.
These restrictions apply in Safe Mode, the default. A package that needs a native add-on or file-system access works only in Developer Mode. Asymmetric signing itself is not restricted — it is require('crypto')’s asymmetric functions (createSign, generateKeyPair and friends) that are unavailable in Safe mode, while a pure-JavaScript library such as jsrsasign signs RS256 in either mode. See Script execution modes.