Postman API Platform

Overview

This document provides a detailed guide to integrating the Postman API Platform with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on events triggered in Postman. The guide includes steps for setting up events in Postman, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• Postman API Platform Account: Access to Postman for creating events and managing notifications.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from Postman.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

• Generate an API Token:
• Follow the guide on How to Create API Token in Callgoose SQIBS.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from Postman will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with Postman notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring Postman API Platform to Send JSON Payloads

To configure Postman to generate the JSON payloads, follow the steps outlined below. These steps will guide you through setting up the necessary events and webhook notifications within Postman to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Webhook in Postman API Platform

To generate the required JSON payloads, you first need to set up events within Postman.

• Log in to the Postman:
• Access the Postman API Platform using your account credentials.
• If a workspace does not exist, create one.
• Create new collections, monitors etc in your workspace. Refer Postman API Documentation for more details.
• Setting up Webhook:
• From the home page, click on Integrations.
• Select Browse All Integrations.
• Click on Webhooks.
• Select the event type for the webhook configuration. (For example Post monitoring results)
• Enter a nickname.
• Select the workspace.
• Choose the created monitor if the Post Monitoring Results event has been selected.
• Provide the API endpoint URL obtained from Callgoose Sqibs. Refer to the API Endpoint documentation for more details on selecting the final endpoint format.
• Click on Add Integration.

3.2 Finalizing and Testing

• Validate the Integration:
• Trigger the event condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the Postman events, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payload from Postman API Platform

Post Monitoring Results

json

{
"collection_name": "Integration testing basics",
"collection_uid": "f7fe2b89-c5df-456c-9bf0-aad06872bd62",
"user_name": "Robert",
"user_id": "38396923",
"monitor_name": "Test Monitor",
"monitor_uid": "1ef75672-9bb5-4980-a268-c5886e883ea1",
"environment_name": "New Environment",
"environment_uid": "15b23cec-6e5c-4ade-a493-e2aa17045c79",
"metrics": {
"errorCount": 0,
"failedTestCount": 1,
"passedTestCount": 0,
"requestCount": 1,
"responseLatency": 121,
"warningCount": 0
}
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Postman API Platform integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: “metrics”
• Key Value Contains: null
• Map Incident With: null
• Incident Title From: "monitor_name"
• This will use the monitor name as the incident title in Callgoose SQIBS.
• You can also configure the API endpoint URL from Callgoose Sqibs using the 'from' URL parameter. The 'from' parameter value will be used if the payload does not contain the specific Incident title key specified in the API filter. Refer to the API endpoint documentation for more details.
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Incident Mapped With: null

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by Honeycomb.

5. Testing and Validation

5.1 Triggering Alerts:

• Simulate an API Event:
• In Postman, manually trigger an event by simulating a condition (e.g.causing a failure in the collections).
• Verify Incident Creation:
• Check that an incident is created in Callgoose SQIBS with the correct title, urgency, description.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
• Postman Permissions: Confirm that the webhook in Postman has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in Postman is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by Postman matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate Postman API Platform with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that events from Postman are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both Postman and Callgoose SQIBS:

• Postman API Platform Documentation
• Callgoose SQIBS API Token Documentation: How to Create API Token
• Callgoose SQIBS API Endpoint Documentation: API Endpoint Details
• API Filter Instructions and FAQ: API Filter Instructions
• How to Send API: Sending API

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time alerts from the Postman API Platform.