WebSitePulse

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Monitoring Target in WebSitePulse

• Create a Monitoring Target in WebSitePulse
• Log into your WebSitePulse account.
• Navigate to the Targets menu.
• Click on Create New Target.
• Choose the type of monitoring, such as:
• Website Availability and Performance Monitoring
• Select other types based on your requirements.
• Configure the monitor by following the on-screen instructions and entering the required details.
• Once configured, click Save and Start Monitoring.

3.2 Setting Up Webhook in WebSitePulse

• Set Up Alert Notifications
• Go to the Contacts section in WebSitePulse.
• In the URL Contact field, click on Create New.
• Fill in the details as follows:
• Label: Provide a descriptive name for this contact.
• URL: Paste the endpoint URL provided by Callgoose SQIBS.
• Refer to the API End Point documentation for guidance on URL structure and parameters.
• Configure Alert Settings
• Choose POST as the request method.
• Click on Continue.
• Configure the active period for this alert.
• Click Add New Rule and then Continue.
• Select the appropriate Target Type and Alert Type.
• Assign Alerts to Targets
• Link the configured alert to the created target.
• Choose specific events to monitor, such as: Connection-related issues or Recovery messages etc.
• Click Continue.
• Review and Save
• Review all configurations to ensure they align with your requirements.
• Click Save to finalize the 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 WebSitePulse 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 WebSitePulse 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 WebSitePulse 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 WebSitePulse 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.
• WebSitePulse Permissions: Confirm that the webhook in WebSitePulse 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 WebSitePulse 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 WebSitePulse matches the expected structure.

8. Conclusion

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

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