Skip to content
Postman API Testing Tips

How To Use Postman Desktop Agent

API Testing Blog

Understanding the Postman Desktop Agent

The Postman Desktop Agent is a powerful tool that allows you to extend Postman’s capabilities by adding custom code and scripts. It enables you to:

  • Automate tedious tasks: Repetitive API interactions can be streamlined.
  • Execute complex workflows: Perform multiple API calls and manipulate data in between.
  • Integrate with external systems: Connect your API testing with other tools and services.

Getting Started with the Postman Desktop Agent

  1. Install Node.js: The Postman Desktop Agent is built on Node.js, so ensure you have it installed. You can download it from https://nodejs.org/.
  2. Install the Postman Agent CLI: Open your terminal and run: npm install -g postman-agent
  3. Enable the Agent in Postman: In Postman, go to Settings > General > Agents and enable the Desktop Agent.

Running a Simple Agent Script

1. Create a New Agent Script:

  • Click on + New in the Postman console.
  • Select Agent.
  • Choose a name for your agent (e.g., myFirstAgent).

2. Write Your Script (JavaScript):

const pm = require('postman-runtime');


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

3. Execute the Script:

  • Create a new request or use an existing one.
  • In the Pre-request Script or Tests tab, select your agent.
  • Run the request.

This script checks the response status code and fails the test if it’s not 200.

Common Use Cases for Postman Desktop Agent

1. Data Manipulation:

Example: Extracting and Using Data from a Previous Request:

const pm = require('postman-runtime');


pm.test('Extract User ID', function () {
  const userId = pm.response.json().id;
  pm.globals.set('userId', userId);
});

2. Handling Authentication:

Example: Managing API Keys:

const pm = require('postman-runtime');


pm.test('Set API Key', function () {
  const apiKey = 'YOUR_API_KEY';
  pm.environment.set('apiKey', apiKey);
});

3. Accessing External Systems:

Example: Sending SMS Notifications:

const pm = require('postman-runtime');
const twilio = require('twilio');


pm.test('Send SMS', function () {
  const accountSid = 'YOUR_TWILIO_ACCOUNT_SID';
  const authToken = 'YOUR_TWILIO_AUTH_TOKEN';
  const client = new twilio(accountSid, authToken);


  client.messages
    .create({
      body: 'Test SMS from Postman Agent',
      from: '+1234567890',
      to: '+1987654321',
    })
    .then((sms) => {
      console.log('SMS sent successfully:', sms.sid);
    })
    .catch((error) => {
      console.error('Error sending SMS:', error);
    });
});

Troubleshooting and Best Practices

  • Use console.log() to debug your agent scripts.
  • Use clear and descriptive variable names.
  • Break down complex tasks into smaller, reusable functions.
  • Document your agent scripts clearly.
  • Consider using a version control system to manage and track changes.

Examples with Step-by-Step Guides

For detailed examples of how to use the Postman Desktop Agent for specific tasks, you can refer to the official Postman documentation or search for relevant tutorials online.

Conclusion

The Postman Desktop Agent empowers you to automate and extend your API testing workflow beyond the capabilities of the basic Postman environment. By leveraging the power of scripts and integrations, you can achieve remarkable efficiency and flexibility in your API testing process.

API Testing Blog