Import packages into your scripts

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

const variableName = require('module-name');

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

Example

// Importing moment for date formatting
const moment = require('moment');

const current = moment().format('YYYY-MM-DD HH:mm:ss');
console.log('Current Time:', current);

// Importing uuid to generate unique IDs
const { v4: uuidv4 } = require('uuid');
console.log('Generated ID:', uuidv4());

Use Global Objects

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

Available Globals

Global	Description	Example
require	Import supported libraries into your script.	`const moment = require('moment');`
xml2Json	Convert XML string to JSON object.	`const data = xml2Json(rq.response.text());`
_	Lodash global for data manipulation utilities.	`const result = _.map([1,2,3], n => n * 2);`

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:

Library	Description	Documentation
ajv	JSON Schema validator for validating API responses.	Ajv Docs
chai	Assertion library for adding test-like validations in scripts.	Chai Docs
cheerio	Parse and manipulate HTML/XML using a jQuery-like syntax.	Cheerio Docs
crypto-js	Hashing and HMAC utilities. Also available as the bare `CryptoJS` global.	crypto-js Docs
csv-parse/lib/sync	Parse CSV data synchronously into objects.	csv-parse Docs
lodash	Utility library for data manipulation.	Lodash Docs
moment	Library for date and time formatting and manipulation.	Moment.js Docs
uuid	Generate unique identifiers (UUID v4, etc.).	uuid Docs
xml2js	XML parsing and building utilities.	xml2js Docs

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:

// Latest version
const jwt = require('jsonwebtoken');

// Pinned to a version
const jsrsasign = require('[email protected]');

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:

const helpers = require('signing-helpers.js');

const signature = helpers.sign(rq.request.body ?? '');

A Custom Package belongs to the project it was created in. To use one in another project, export it and import it there.

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

const moment = require('moment');
const { v4: uuidv4 } = require('uuid');
const CryptoJS = require('crypto-js');

const id = uuidv4();
const time = moment().format('HH:mm:ss');
const digest = CryptoJS.SHA256(id).toString();

console.log('Request ID:', id, 'Time:', time, 'Digest:', digest);

Use Built-in Globals

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

Examples

if (rq.response.code === 200) {
  const parsed = xml2Json(rq.response.text());
  console.log('Converted XML:', parsed);
}

const upper = _.toUpper('requestly');
console.log(upper);

Notes

A set of Node.js built-in modules is also available via require(). In Safe mode — the default — these resolve: crypto, buffer, events, util, stream, zlib.
These do not resolve in Safe mode and throw a guided error naming the reason: assert, path, punycode, querystring, string_decoder, url. Modules that need the filesystem, a network socket, or a child process (fs, net, child_process) are never available.
require('cheerio') does not currently load in Safe mode. Use Developer mode if you need it.
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.

Getting Started

API Design

Mock Server

Collaboration & Projects

Account & Administration

Import packages into your scripts

require

Syntax

Example

Use Global Objects

Available Globals

Use External Libraries

Supported Libraries

Install a package from npm

If your organization restricts external packages

Require your own code as a package

Use Built-in Globals

Examples

Notes

​require

​Syntax

​Example

​Use Global Objects

​Available Globals

​Use External Libraries

​Supported Libraries

​Install a package from npm

​If your organization restricts external packages

​Require your own code as a package

​Use Built-in Globals

​Examples

​Notes

require

Syntax

Example

Use Global Objects

Available Globals

Use External Libraries

Supported Libraries

Install a package from npm

If your organization restricts external packages

Require your own code as a package

Use Built-in Globals

Examples

Notes