StatusEntry

Overview

This document provides a detailed guide to integrating StatusEntry 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 alerts triggered in StatusEntry. The guide includes steps for setting up alerts in StatusEntry, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• StatusEntry Account: Access to StatusEntry for creating alerts 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 StatusEntry.

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 StatusEntry will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with StatusEntry 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 StatusEntry to Send JSON Payloads

Follow these steps to set up monitoring, alerts, and webhook integrations in StatusEntry, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Configuring Webhook Notification in StatusEntry

• Log in to Statusentry
• Navigate to the Statusentry login page.
• Enter your credentials and log in.
• Access the Integrations Section
• Once logged in, click on the Integrations tab in the main menu.
• Configure Webhook Integration
• In the Integrations page, locate the Webhook integration option.
• Click on the Configure button under the Webhook integration.
• Provide the API Endpoint URL
• Paste the API Endpoint URL provided by Callgoose SQIBS into the designated field.
• The API Endpoint URL may vary based on authentication and other URL parameters. To find the appropriate API Endpoint URL for your integration:
• Visit the Callgoose SQIBS API Endpoint Documentation.
• Follow the instructions to identify your final API Endpoint.
• Finalize the Integration
• After pasting the API Endpoint URL, click on the Add button to complete the configuration.

3.2 Finalizing and Testing

• Validate the Integration:
• Trigger the alert 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 effectively manage incidents from StatusEntry alerts, configure API filters with default values set to null for all key fields. This ensures the filters can gracefully handle empty payloads or those with a Content-Type other than application/json.

4.1.1 Integration Templates

If you see a StatusEntry integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. Since StatusEntry sends empty payloads, the fields within the template may default to empty.

4.1.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Map Incident With: null
• Incident Title From: null
• Incident Description From: null
• 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.2 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in StatusEntry that causes an alert (e.g., Manually create an incident.).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

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.
• StatusEntry Permissions: Confirm that the webhook in StatusEntry 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 StatusEntry 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 StatusEntry matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate StatusEntry with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from StatusEntry 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 StatusEntry and Callgoose SQIBS:

• StatusEntry Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send 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 StatusEntry.