Upzilla

Overview

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

Prerequisites

• Upzilla Account: Access to Upzilla 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 Upzilla.

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Webhook in Upzilla

• Log in
• Access the Upzilla platform using your credentials.
• Navigate to Notifications
• After logging in, click on the Notifications tab.
• Add a New Webhook
• Click on Add and select Webhooks from the options.
• Configure the Webhook
• Click on Add Webhook.
• Provide a meaningful name for the webhook (e.g., "Callgoose Alert Webhook").
• Paste the Endpoint URL provided by Callgoose SQIBS into the Webhook URL field.
• Find your final API End Point here.
• Ensure the Active checkbox is ticked.
• Save the Webhook
• Click Save to finalize the webhook configuration.

3.2 Setting Up Monitor in Upzilla

• Navigate to Monitors
• Go to the Monitors section in Upzilla.
• Add a New Monitor
• Click on Add New to create a monitor.
• Select Monitoring Type
• Choose the type of monitoring based on your requirements:
• Example options: Uptime Monitor, Web Server etc
• Configure the Monitor
• Provide the required details based on the selected monitor type and configure the settings according to your requirements.
• Set Notification Options
• By default, notifications are set to Email. Although webhooks are not explicitly listed here, any previously created webhook will still be triggered for relevant alerts.
• Save the Monitor
• Click Save to complete the monitor setup.

3.3 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 Upzilla 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 an Upzilla 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 Upzilla 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 Upzilla that causes an alert (e.g., Manually make the website or server offline).
• 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.
• Upzilla Permissions: Confirm that the webhook in Upzilla 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 Upzilla 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 Upzilla matches the expected structure.

8. Conclusion

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

• Upzilla 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 Upzilla.