Alert configuration in Postman - Build an Automation Script

Verify alert configuration API creates and retrieves alert settings

Preconditions (3)

Step 1: Send a POST request to /api/alerts with JSON body containing alert settings (e.g., type, threshold, enabled)

Step 2: Verify the response status code is 201 Created

Step 3: Send a GET request to /api/alerts/{alertId} using the ID from the POST response

Step 4: Verify the response status code is 200 OK

Step 5: Verify the response body contains the same alert settings as sent in the POST request

✅ Expected Result: Alert configuration is created successfully and retrieved with matching settings

Automation Requirements - Postman test scripts

Assertions Needed:

Response status code is 201 for POST

Response status code is 200 for GET

Response body fields match the sent alert configuration

Best Practices:

Use environment variables for API base URL and authentication token

Validate response schema and values

Chain requests using Postman scripting to reuse alert ID

Use descriptive test names and comments

Automated Solution

Postman

pm.test('POST /api/alerts returns 201', function () {
    pm.response.to.have.status(201);
    const jsonData = pm.response.json();
    pm.environment.set('alertId', jsonData.id);
    pm.expect(jsonData.type).to.eql(pm.variables.get('alertType'));
    pm.expect(jsonData.threshold).to.eql(pm.variables.get('alertThreshold'));
    pm.expect(jsonData.enabled).to.eql(pm.variables.get('alertEnabled'));
});

// In GET /api/alerts/{{alertId}} request tests
pm.test('GET /api/alerts/{{alertId}} returns 200', function () {
    pm.response.to.have.status(200);
    const jsonData = pm.response.json();
    pm.expect(jsonData.id).to.eql(pm.environment.get('alertId'));
    pm.expect(jsonData.type).to.eql(pm.variables.get('alertType'));
    pm.expect(jsonData.threshold).to.eql(pm.variables.get('alertThreshold'));
    pm.expect(jsonData.enabled).to.eql(pm.variables.get('alertEnabled'));
});

The first test script runs after the POST request to create an alert configuration. It checks the status code is 201, meaning the alert was created. It then parses the JSON response and saves the alert ID to an environment variable for reuse. It also verifies the returned alert settings match the expected values stored in variables.

The second test script runs after the GET request to retrieve the alert by ID. It checks the status code is 200, meaning success. It verifies the alert ID and settings in the response match the values saved earlier. This chaining ensures the alert was created and retrieved correctly.

Using environment variables for the alert ID and expected values allows easy reuse and maintenance. Assertions check both status codes and response content for full validation.

Common Mistakes - 3 Pitfalls

Hardcoding API URLs and tokens inside test scripts

Not checking response status codes before parsing JSON

Not saving created resource IDs for later requests

Bonus Challenge

Now add data-driven testing with 3 different alert configurations

Show Hint

Practice

1. What is the main purpose of configuring alerts in Postman during API testing?

easy

A. To notify testers when a test condition fails

B. To automatically fix API errors

C. To generate API documentation

D. To speed up API response times

Solution

1. Step 1: Understand alert purpose in testing

   Alerts are used to inform testers about issues or failures during tests.

2. Step 2: Identify correct alert function

   Alerts notify when test conditions fail, helping catch problems early.

3. Final Answer:

   To notify testers when a test condition fails -> Option A

4. Quick Check:

   Alerts = Notifications on failure [OK]

Hint: Alerts notify failures, not fix or document [OK]

Common Mistakes:

• Thinking alerts fix errors automatically
• Confusing alerts with documentation tools
• Assuming alerts improve response speed

2. Which of the following is the correct way to set an alert message in a Postman test script when a response status is not 200?

easy

A. pm.test('Status is 200', () => pm.response.to.have.status(200));

B. pm.alert('Status is not 200');

C. pm.test('Status is 200', () => { if(pm.response.code !== 200) pm.alert('Status is not 200'); });

D. pm.response.alert('Status check');

Solution

1. Step 1: Identify correct test syntax

   Postman uses pm.test() to define tests and pm.response.to.have.status() to check status.

2. Step 2: Check alert usage

   pm.alert() is not a valid Postman function; alerts come from test failures.

3. Final Answer:

   pm.test('Status is 200', () => pm.response.to.have.status(200)); -> Option A

4. Quick Check:

   Use pm.test with assertions [OK]

Hint: Use pm.test with assertions, no pm.alert function [OK]

Common Mistakes:

• Using pm.alert which does not exist
• Trying to call alert on response object
• Not using pm.test for assertions

3. Given this Postman test script:

pm.test('Response time is less than 500ms', () => {
  pm.expect(pm.response.responseTime).to.be.below(500);
});

What will happen if the response time is 600ms?

medium

A. The test will pass and no alert is shown

B. The test will pass but an alert is triggered

C. The script will cause a syntax error

D. The test will fail and an alert is triggered

Solution

1. Step 1: Understand the test condition

   The test expects response time below 500ms.

2. Step 2: Analyze response time 600ms

   600ms is above 500ms, so the condition fails and test fails.

3. Final Answer:

   The test will fail and an alert is triggered -> Option D

4. Quick Check:

   Fail if responseTime >= 500ms [OK]

Hint: Fail test if condition false triggers alert [OK]

Common Mistakes:

• Assuming test passes despite failure
• Thinking alerts show on pass
• Confusing syntax error with test failure

4. You wrote this Postman test script:

pm.test('Check status', () => {
  pm.expect(pm.response.status).to.equal(200);
});

But the test always fails even when the API returns 200. What is the error?

medium

A. pm.expect is used incorrectly

B. pm.test syntax is wrong

C. pm.response.status should be pm.response.code

D. The API never returns 200

Solution

1. Step 1: Check property for status code

   Postman uses pm.response.code for status code, not pm.response.status.

2. Step 2: Correct the property usage

   Replace pm.response.status with pm.response.code to fix the test.

3. Final Answer:

   pm.response.status should be pm.response.code -> Option C

4. Quick Check:

   Use pm.response.code for status [OK]

Hint: Use pm.response.code, not pm.response.status [OK]

Common Mistakes:

• Using pm.response.status instead of pm.response.code
• Misusing pm.expect syntax
• Assuming API never returns 200 without checking

5. You want to configure an alert in Postman that triggers only when the response JSON has a field error set to true. Which test script correctly sets this alert?

hard

A. pm.test('Error field check', () => {
pm.expect(pm.response.json().error).to.be.false;
});

B. pm.test('Error field check', () => {
const json = pm.response.json();
pm.expect(json.error).to.eql(true);
});

C. pm.test('Error field check', () => {
const json = pm.response.json();
if(json.error === true) pm.alert('Error found');
});

D. pm.test('Error field check', () => {
pm.response.to.have.jsonBody('error', true);
});

Solution

1. Step 1: Understand how to check JSON field in Postman

   Use pm.response.json() to parse JSON, then assert field value.

2. Step 2: Identify correct assertion syntax

   pm.expect(...).to.eql(true) correctly asserts that error is true, triggering failure if not.

3. Step 3: Evaluate options

   pm.test('Error field check', () => { pm.expect(pm.response.json().error).to.be.false; }); expects error to be false, which is opposite of requirement; pm.test('Error field check', () => { const json = pm.response.json(); if(json.error === true) pm.alert('Error found'); }); uses invalid pm.alert; pm.test('Error field check', () => { pm.response.to.have.jsonBody('error', true); }); uses invalid method.

4. Final Answer:

   pm.test('Error field check', () => { const json = pm.response.json(); pm.expect(json.error).to.eql(true); }); -> Option B

5. Quick Check:

   Use pm.expect(...).to.eql(true) to assert error true [OK]

Hint: Use pm.expect with .to.eql(true) for boolean alerts [OK]

Common Mistakes:

• Using pm.alert which does not exist
• Incorrect assertion methods
• Not parsing JSON before checking