Request Chaining

​

Overview

• bru.runRequest() - Execute requests within your collection
• bru.sendRequest() - Send programmatic HTTP requests
• bru.runner.setNextRequest() - Control request execution order in collection runs

​

bru.runRequest()

​

Syntax

const requestResponse = await bru.runRequest(
  "folder/subfolder/request-name"
);

​

Parameters

• requestPath: The path to the request relative to the collection root, using folder names as segments and the request name (without the .bru extension) as the last segment. For a request at the collection root, pass just the request name (e.g. "Login"). For a nested request, join the folder names with / (e.g. "auth/Login").

​

Returns

• status: HTTP status code (number)
• statusText: HTTP status text (string)
• headers: Response headers object
• data: Parsed response body — automatically decoded to a JavaScript object when the response is JSON, otherwise a string
• duration: Response time in milliseconds
• size: Response size in bytes
• url: The final request URL

​

Examples

​

Basic Request Execution

// Execute a request and get the response
const response = await bru.runRequest("auth/login");

// Check if login was successful
if (response.status === 200) {
  const data = response.data;
  bru.setVar("authToken", data.token);
  console.log("Login successful, token saved");
} else {
  console.error("Login failed:", response.statusText);
}

​

bru.sendRequest()

​

Syntax

await bru.sendRequest({
  method: string,
  url: string,
  headers?: object,
  data?: string | object,
  timeout?: number
}, callback)

​

Parameters

• method: HTTP method (GET, POST, PUT, DELETE, etc.)
• url: The URL to send the request to
• headers: (Optional) Request headers object
• data: (Optional) Request data. Can be a string or object
• timeout: (Optional) Request timeout in milliseconds
• callback: Function to handle the response with signature (err, res)

​

Examples

​

Basic HTTP Request

await bru.sendRequest({
  method: 'GET',
  url: 'https://api.example.com/users',
  headers: {
    'Authorization': 'Bearer ' + bru.getVar('authToken'),
    'Content-Type': 'application/json'
  }
}, function (err, res) {
  if (err) {
    console.error('Error:', err);
    return;
  }
  console.log('Users:', res.data);
  bru.setVar('users', res.data);
});

​

POST Request with Data

const userData = {
  name: 'John Doe',
  email: 'john@example.com'
};

await bru.sendRequest({
  method: 'POST',
  url: 'https://api.example.com/users',
  headers: {
    'Authorization': 'Bearer ' + bru.getVar('authToken'),
    'Content-Type': 'application/json'
  },
  data: userData,
  timeout: 10000
}, function (err, res) {
  if (err) {
    console.error('Error creating user:', err);
    return;
  }
  
  if (res.status === 201) {
    console.log('User created:', res.data);
    bru.setVar('newUserId', res.data.id);
  }
});

​

bru.runner.setNextRequest()

​

Syntax

bru.runner.setNextRequest("request-name");

​

Parameters

• requestName: The name of the next request to execute (string) or null to stop execution

​

How it works

• setNextRequest works with single requests - it executes the current request first, then jumps to the specified request
• It skips all requests between the current one and the target request
• The target request must exist in the collection and be specified by its exact name
• For requests inside folders: Use just the request name (e.g., “request-name”), not the full path

​

Examples

​

Conditional Request Execution

// In post-request script
const response = res.getBody();

if (response.status === 'active') {
  // Continue to next request
  bru.runner.setNextRequest("process-active-user");
} else if (response.status === 'inactive') {
  // Skip to different request
  bru.runner.setNextRequest("handle-inactive-user");
} else {
  // Stop execution
  bru.runner.setNextRequest(null);
}

• Use bru.runRequest() for requests within your collection (faster, uses existing configuration)
• Use bru.sendRequest() for external APIs or when you need custom request configuration
• Avoid nested loops that could cause infinite request chains