Scripting

LiteClient supports JavaScript scripting to automate API workflows. Write pre-request scripts to set variables or generate tokens before requests are sent, and post-response scripts to validate responses and extract data.

Script Types

LiteClient provides two types of scripts:

Pre-Request Scripts
Post-Response (Test) Scripts

Pre-request scripts run before the request is sent. Use them to:

Set environment variables dynamically
Generate authentication tokens or signatures
Modify request state
Log pre-request information

Example:

// Set a timestamp variable
pm.environment.set('timestamp', Date.now());

// Generate a random request ID
pm.environment.set('requestId', Math.random().toString(36).substring(7));

console.log('Request ID:', pm.variables.get('requestId'));

Post-response scripts run after the response is received. Use them to:

Write assertions and tests
Extract data from responses
Set variables based on response data
Log response information

Example:

// Test status code
pm.test('Status code is 200', function() {
  pm.response.to.have.status(200);
});

// Extract token from response
const jsonData = pm.response.json();
pm.environment.set('authToken', jsonData.token);

console.log('Token saved:', jsonData.token);

The pm API

LiteClient provides a Postman-compatible pm API for interacting with environments, globals, requests, and responses.

pm.environment

Manage environment variables:

// Get a variable
const baseUrl = pm.environment.get('baseUrl');

// Set a variable
pm.environment.set('userId', '12345');

// Check if variable exists
if (pm.environment.has('apiKey')) {
  console.log('API key is configured');
}

// Unset a variable
pm.environment.unset('tempValue');

Variables set via pm.environment.set() are automatically persisted to the active environment. New variables are created if they don’t exist.

pm.globals

Manage global variables (available across all environments):

// Get a global variable
const apiVersion = pm.globals.get('apiVersion');

// Set a global variable
pm.globals.set('lastRequestTime', Date.now());

// Check if global exists
if (pm.globals.has('orgId')) {
  console.log('Organization ID is set globally');
}

// Unset a global variable
pm.globals.unset('tempGlobal');

pm.variables

Access variables from all scopes with automatic resolution:

// Get variable (resolves Environment → Collection → Global)
const baseUrl = pm.variables.get('baseUrl');

// Set variable in current environment
pm.variables.set('requestCount', 42);

pm.variables.get() follows the layered resolution order: Environment → Collection → Global. The narrowest scope wins.

pm.request

Access request metadata (available in both pre-request and post-response scripts):

// Get request URL
const url = pm.request.url.toString();
console.log('Request URL:', url);

// Get request method
const method = pm.request.method;
console.log('Method:', method);

// Access headers
const headers = pm.request.headers;
console.log('Content-Type:', headers.get('Content-Type'));

pm.response

Access response data (only available in post-response scripts):

// Get status code
const status = pm.response.code;
console.log('Status:', status);

// Get response time
const time = pm.response.responseTime;
console.log('Response time:', time, 'ms');

// Parse JSON response
const jsonData = pm.response.json();
console.log('User ID:', jsonData.id);

// Get response body as text
const bodyText = pm.response.text();

// Access response headers
const contentType = pm.response.headers.get('Content-Type');

pm.test()

Write assertions and tests:

// Basic assertion
pm.test('Status code is 200', function() {
  pm.response.to.have.status(200);
});

// Multiple assertions
pm.test('Response is valid', function() {
  pm.response.to.be.ok;
  pm.response.to.be.json;
  pm.response.to.have.header('Content-Type', /json/);
});

// Test response body
pm.test('Response has user data', function() {
  const jsonData = pm.response.json();
  pm.expect(jsonData).to.have.property('id');
  pm.expect(jsonData.name).to.be.a('string');
  pm.expect(jsonData.email).to.include('@');
});

pm.expect()

ChaiJS-style assertions:

// Number assertions
pm.expect(pm.response.code).to.equal(200);
pm.expect(pm.response.responseTime).to.be.below(500);

// String assertions
const jsonData = pm.response.json();
pm.expect(jsonData.name).to.be.a('string');
pm.expect(jsonData.email).to.include('@example.com');

// Object assertions
pm.expect(jsonData).to.have.property('id');
pm.expect(jsonData.roles).to.be.an('array');
pm.expect(jsonData.roles).to.include('admin');

// Boolean assertions
pm.expect(jsonData.active).to.be.true;

pm.sendRequest()

Make HTTP requests from within scripts. This enables token fetching, dynamic lookups, and multi-step API workflows:

// Simple GET request
pm.sendRequest('https://api.example.com/health', function (err, res) {
    console.log('Health check status:', res.code);
});

// POST request with headers and body
pm.sendRequest({
    url: 'https://api.example.com/auth/token',
    method: 'POST',
    header: { 'Content-Type': 'application/json' },
    body: { raw: JSON.stringify({ client_id: pm.environment.get('clientId'), grant_type: 'client_credentials' }) }
}, function (err, res) {
    if (!err) {
        const token = res.json().access_token;
        pm.environment.set('authToken', token);
        console.log('Token acquired');
    }
});

pm.sendRequest() is limited to 5 calls per script execution and shares the 10-second script timeout. The callback receives (error, response) where response has .code, .status, .headers, .json(), and .text() methods.

Console Logging

Use standard console methods for debugging:

// Info logging
console.log('Request started');
console.info('Using environment:', pm.environment.name);

// Warning logging
console.warn('Deprecated API version detected');

// Error logging
console.error('Authentication failed');

// Log objects
const user = { id: 123, name: 'John' };
console.log('User data:', user);

Console output appears in the Tests tab after request execution. Output is capped at 200 entries per script.

Script Examples

Pre-Request Script Examples

Generate HMAC signature

// Generate timestamp
const timestamp = Date.now();
pm.environment.set('timestamp', timestamp);

// Create signature (pseudo-code - use crypto library in real implementation)
const message = pm.request.method + pm.request.url + timestamp;
const signature = generateHMAC(message, pm.environment.get('secretKey'));
pm.environment.set('signature', signature);

console.log('Signature generated for timestamp:', timestamp);

Set dynamic headers

// Set request ID header
const requestId = Math.random().toString(36).substring(7);
pm.environment.set('requestId', requestId);

// Set timestamp
pm.environment.set('timestamp', new Date().toISOString());

console.log('Request ID:', requestId);

Conditional variable setting

// Set different base URLs based on time
const hour = new Date().getHours();
if (hour >= 9 && hour < 17) {
  pm.environment.set('baseUrl', 'https://api.example.com');
} else {
  pm.environment.set('baseUrl', 'https://api-night.example.com');
}

console.log('Using base URL:', pm.environment.get('baseUrl'));

Post-Response Script Examples

Extract and save token

pm.test('Login successful', function() {
  pm.response.to.have.status(200);
  
  const jsonData = pm.response.json();
  pm.expect(jsonData).to.have.property('token');
  
  // Save token for future requests
  pm.environment.set('authToken', jsonData.token);
  console.log('Auth token saved');
});

Validate response structure

pm.test('Response structure is valid', function() {
  const jsonData = pm.response.json();
  
  // Check required fields
  pm.expect(jsonData).to.have.property('id');
  pm.expect(jsonData).to.have.property('name');
  pm.expect(jsonData).to.have.property('email');
  
  // Validate types
  pm.expect(jsonData.id).to.be.a('number');
  pm.expect(jsonData.name).to.be.a('string');
  pm.expect(jsonData.email).to.match(/^[^@]+@[^@]+\.[^@]+$/);
});

Performance testing

pm.test('Response time is acceptable', function() {
  pm.expect(pm.response.responseTime).to.be.below(500);
});

pm.test('Response size is reasonable', function() {
  const bodySize = pm.response.text().length;
  pm.expect(bodySize).to.be.below(100000); // 100KB
});

console.log('Response time:', pm.response.responseTime, 'ms');
console.log('Response size:', pm.response.text().length, 'bytes');

Chain requests with variables

pm.test('User created successfully', function() {
  pm.response.to.have.status(201);
  
  const jsonData = pm.response.json();
  
  // Save user ID for next request
  pm.environment.set('userId', jsonData.id);
  
  console.log('User created with ID:', jsonData.id);
  console.log('Use {{userId}} in the next request');
});

Chain requests with pm.sendRequest

// Fetch a token, then verify the user with a follow-up call
const userId = pm.response.json().id;

pm.sendRequest({
  url: 'https://api.example.com/users/' + userId,
  method: 'GET',
  header: { 'Authorization': 'Bearer ' + pm.environment.get('authToken') }
}, function (err, res) {
  pm.test('Follow-up GET returns the created user', function () {
    pm.expect(res.code).to.equal(200);
    pm.expect(res.json().id).to.equal(userId);
  });
});

Script Execution

Sandboxed Environment

Scripts run in a Node.js VM sandbox with the following constraints:

10-second timeout - Scripts that exceed 10 seconds are automatically terminated
100KB size limit - Scripts larger than 100KB are rejected
200 console entries - Console output is capped at 200 entries
200 test results - Test results are capped at 200 tests
5 pm.sendRequest() calls - HTTP requests from scripts are capped at 5 per execution

Scripts have no access to the file system or VS Code APIs. Network access is available only via pm.sendRequest(). They run in an isolated environment for security.

Error Handling

When scripts fail, errors are displayed in the Tests tab with line numbers:

[ERROR] Script execution failed at line 5
ReferenceError: undefinedVariable is not defined
  at test script:5

Use try-catch blocks in complex scripts to handle errors gracefully and provide meaningful error messages.

Postman Import/Export

Scripts are fully preserved when importing and exporting Postman Collection v2.1 files:

Pre-request scripts are imported as-is
Test scripts are imported as post-response scripts
Collection-level and folder-level scripts show a warning (not yet supported)

LiteClient currently supports request-level scripts only. Collection-level and folder-level scripts from Postman collections are not executed.

Best Practices

Keep scripts simple and focused

Write concise scripts that do one thing well. Complex logic is harder to debug and maintain. Break large workflows into multiple requests.

Use descriptive test names

Name tests clearly so failures are easy to understand: “Status code is 200”, “Response contains user ID”, “Email format is valid”.

Log important state changes

Use console.log() to track variable changes, token generation, and workflow progress. This helps with debugging.

Handle missing data gracefully

Check if properties exist before accessing them to avoid script errors:

const data = pm.response.json();
if (data && data.token) {
  pm.environment.set('token', data.token);
}

Use variables for reusability

Extract tokens, IDs, and other dynamic values into variables so subsequent requests can use them. This enables request chaining.

Getting Started

Core Features

Guides

Script Types

The pm API

pm.environment

pm.globals

pm.variables

pm.request

pm.response

pm.test()

pm.expect()

pm.sendRequest()

Console Logging

Script Examples

Pre-Request Script Examples

Post-Response Script Examples

Script Execution

Sandboxed Environment

Error Handling

Postman Import/Export

Best Practices

Getting Started

Core Features

Guides

Documentation Index

​Script Types

​The pm API

​pm.environment

​pm.globals

​pm.variables

​pm.request

​pm.response

​pm.test()

​pm.expect()

​pm.sendRequest()

​Console Logging

​Script Examples

​Pre-Request Script Examples

​Post-Response Script Examples

​Script Execution

​Sandboxed Environment

​Error Handling

​Postman Import/Export

​Best Practices

Script Types

The pm API

pm.environment

pm.globals

pm.variables

pm.request

pm.response

pm.test()

pm.expect()

pm.sendRequest()

Console Logging

Script Examples

Pre-Request Script Examples

Post-Response Script Examples

Script Execution

Sandboxed Environment

Error Handling

Postman Import/Export

Best Practices