Creating monitors in Postman - Framework Setup Guide

Framework Mode - Creating monitors

Folder Structure for Postman Monitors

postman-project/
├── collections/
│   └── api-collection.json       # Your API requests collection
├── environments/
│   ├── dev.postman_environment.json
│   └── prod.postman_environment.json
├── monitors/
│   └── monitor-config.json       # Monitor definitions and schedules
├── scripts/
│   ├── pre-request-scripts.js    # Shared scripts for requests
│   └── test-scripts.js           # Shared test scripts
└── README.md

This structure keeps your API collections, environments, and monitor configurations organized.

Test Framework Layers in Postman Monitors

• Collections Layer: Contains API requests grouped logically. Each request has tests and pre-request scripts.
• Environment Layer: Holds variables for different environments (dev, prod) used by collections and monitors.
• Monitor Layer: Defines schedules and configurations to run collections automatically and repeatedly.
• Scripts Layer: Shared JavaScript code for pre-request or test scripts to keep code DRY (Don't Repeat Yourself).
• Configuration Layer: Files or settings that define monitor schedules, notification settings, and environment bindings.

Configuration Patterns for Postman Monitors

• Environment Variables: Use environment files to switch between dev, staging, and production setups easily.
• Monitor Scheduling: Define monitor run frequency (e.g., every hour, daily) in monitor-config.json or via Postman UI.
• Notification Settings: Configure email or webhook alerts for monitor failures or successes.
• Credential Management: Store sensitive data like API keys in environment variables, never hard-coded in collections.
• Version Control: Keep collections and monitor configs in source control (Git) for traceability and collaboration.

Test Reporting and CI/CD Integration

• Postman Monitor Reports: Postman provides built-in reports showing monitor run status, response times, and test results.
• Email Notifications: Configure monitors to send email alerts on failures or threshold breaches.
• Webhook Integration: Use webhooks to send monitor results to external systems like Slack or custom dashboards.
• CI/CD Integration: Use Postman CLI (Newman) in pipelines to run collections and monitors as part of automated builds.
• Exporting Reports: Export monitor run data for further analysis or compliance documentation.

Best Practices for Creating Postman Monitors

• Keep Collections Modular: Organize requests logically to make monitors focused and maintainable.
• Use Environment Variables: Avoid hardcoding values; use environments to switch contexts easily.
• Schedule Wisely: Set monitor frequency based on API criticality and rate limits to avoid unnecessary runs.
• Handle Failures Gracefully: Write clear test assertions and use notifications to catch issues early.
• Version Control Everything: Store collections, environments, and monitor configs in Git for team collaboration and rollback.

Self Check Question

Where in this folder structure would you add a new monitor configuration for a payment API that needs to run every 30 minutes?

Key Result

Organize Postman monitors by separating collections, environments, and monitor configs with clear scheduling and notification setups.

Practice

1. What is the main purpose of creating a monitor in Postman?

easy

A. To run API tests automatically on a schedule

B. To manually execute API requests one by one

C. To write new API test scripts

D. To create API documentation

Solution

1. Step 1: Understand what monitors do

   Monitors in Postman are designed to run tests automatically without manual intervention.

2. Step 2: Identify the main use

   They run API tests on a schedule to catch issues early.

3. Final Answer:

   To run API tests automatically on a schedule -> Option A

4. Quick Check:

   Monitors = Automated scheduled tests [OK]

Hint: Monitors run tests automatically, not manually [OK]

Common Mistakes:

• Thinking monitors are for manual testing
• Confusing monitors with writing test scripts
• Assuming monitors create documentation

2. Which of the following is required before creating a monitor in Postman?

easy

A. A manual test run report

B. An active Postman environment variable

C. A Postman workspace with no collections

D. A saved collection with tests

Solution

1. Step 1: Recall monitor prerequisites

   Monitors need a saved collection that contains tests to run automatically.

2. Step 2: Check other options

   Environment variables help but are not strictly required; a workspace without collections cannot run tests; manual reports are unrelated.

3. Final Answer:

   A saved collection with tests -> Option D

4. Quick Check:

   Monitor setup = saved collection needed [OK]

Hint: Monitors need collections with tests saved first [OK]

Common Mistakes:

• Assuming environment variables are mandatory
• Trying to create monitors without collections
• Confusing manual reports with monitor setup

3. Consider this scenario: You create a monitor for a collection that tests an API endpoint. The monitor is set to run every hour. What will happen if the API is down during a monitor run?

medium

A. The monitor will skip the test and report success

B. The monitor run will fail and report errors

C. The monitor will run tests but ignore failures

D. The monitor will automatically fix the API issue

Solution

1. Step 1: Understand monitor behavior on failure

   If the API is down, the requests in the collection will fail during the monitor run.

2. Step 2: Identify monitor reporting

   Monitors report test failures and errors; they do not skip or ignore failures, nor fix issues automatically.

3. Final Answer:

   The monitor run will fail and report errors -> Option B

4. Quick Check:

   API down = monitor reports failure [OK]

Hint: Monitors report errors if API is down during run [OK]

Common Mistakes:

• Thinking monitors skip failed tests
• Believing monitors fix API problems
• Assuming monitor reports success despite failures

4. You created a monitor but it never runs at the scheduled time. What is the most likely reason?

medium

A. The collection used by the monitor was deleted

B. The monitor schedule is set to run every minute

C. The monitor has no tests in the collection

D. The monitor is set to manual run only

Solution

1. Step 1: Check monitor prerequisites

   If the collection linked to the monitor is deleted, the monitor cannot run.

2. Step 2: Evaluate other options

   Running every minute is valid; having no tests means no failures but monitor still runs; monitors do not have manual-only mode.

3. Final Answer:

   The collection used by the monitor was deleted -> Option A

4. Quick Check:

   Deleted collection = monitor won't run [OK]

Hint: Deleted collection breaks monitor runs [OK]

Common Mistakes:

• Assuming schedule frequency stops runs
• Thinking monitors can be manual-only
• Confusing empty tests with no runs

5. You want to create a monitor that runs your API tests every day at 9 AM UTC and sends email alerts only if tests fail. Which steps should you follow?

hard

A. Create a new collection without tests, schedule monitor hourly, disable alerts

B. Save a collection with tests, create a monitor with no schedule, enable all alerts

C. Save a collection with tests, create a monitor scheduled daily at 9 AM UTC, enable email alerts on failure

D. Create a monitor without a collection, schedule daily, enable email alerts

Solution

1. Step 1: Prepare the collection

   You must have a saved collection that contains the API tests to run.

2. Step 2: Configure the monitor schedule and alerts

   Create a monitor scheduled daily at 9 AM UTC and enable email alerts only on test failures.

3. Final Answer:

   Save a collection with tests, create a monitor scheduled daily at 9 AM UTC, enable email alerts on failure -> Option C

4. Quick Check:

   Collection + daily schedule + alerts on failure = correct setup [OK]

Hint: Schedule monitor + enable alerts only on failure [OK]

Common Mistakes:

• Scheduling monitor without tests in collection
• Disabling alerts when failures occur
• Creating monitor without a collection