Wormly

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Monitor in Wormly

• Logging into Wormly
• Use your credentials to log in to your Wormly account.
• Creating a New Host for Monitoring
• From the homepage, click on Create Host.
• Choose a name for your host (e.g., “MyWebsite Monitoring”).
• Select the Testing Interval (e.g., every 5 minutes).
• Choose the appropriate Reporting Time Zone for accurate time tracking.
• Select the Primary Monitoring Node that suits your geographical location or preferences.
• Click on Add This Host to proceed.
• Setting Up Monitoring Sensors
• After adding the host, select the type of monitoring sensor from the options. For instance, choose HTTP Request to monitor a website.
• Fill out the required details for the sensor:
• URL: Enter the URL of the website or service to be monitored.
• Expected HTTP Response: Specify the expected HTTP response code (e.g., 200 for success).
• Expected Text: Enter any specific text you expect to find on the page.
• Unwanted Text: If there’s text that shouldn’t appear, specify it here.
• Click on Save to complete the sensor configuration.

3.2 Setting Up Webhook Integration for Alerts

• Setting Up Alerts
• From the homepage, click on Alerts.
• In the Alerts section, click on Contacts.
• Click on Create New Contact.
• Configuring Webhook for Alerts
• Choose Webhook as the contact type.
• Enter a name for the webhook (e.g., “CallGoose Integration”).
• In the URL field, provide the Endpoint URL obtained from CallGoose Sqibs. Refer to CallGoose’s API endpoint documentation for the correct format.
• Choose Webhook Type as JSON to ensure the alert payload is in JSON format.
• Click on Send Test to ensure the connection is working properly.
• You should check the API Log in CallGoose Sqibs to verify that the payload was sent by Wormly successfully.
• Once confirmed, click on Save to store the webhook configuration.

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.
• Resolve the alert to ensure the resolved state payload is also correctly sent and processed.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from Wormly

Alert Triggered (isrecovery: 0)

json

{
  "hostid": 122653,
  "name": "MGU",
  "isrecovery": 0,
  "downtime": 0,
  "alertlevel": 1,
  "alertlevel_name": "Detected Error",
  "failedsensors": [
    {
      "type": "HTTP",
      "sensorid": 410038,
      "message": "Got response code 200, expected 204"
    }
  ]
}

Alert Resolved (isrecovery: 1)

json

{
  "hostid": 122653,
  "name": "MGU",
  "isrecovery": 1,
  "downtime": 16
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Wormly 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. 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: "isrecovery"
• Key Value Contains: [0]
• Map Incident With: "hostid"
• This corresponds to the unique hostid from the Wormly payload.
• Incident Title From: "alertlevel_name"
• 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.
• Example: If you use the "failedsensors".[0]."message" key in the Incident Description From field, the incident description will be the value of the failedsensors".[0]."message key. In the example JSON payload provided earlier, this would result in a description like "Got response code 200, expected 204."
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "isrecovery"
• Key Value Contains: [1]
• Incident Mapped With: "hostid"
• This ensures the incident tied to the specific incident.key is resolved when the alert status returns to normal.

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 Wormly.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Wormly that causes an alert (e.g., change the Expected HTTP Response from 200 to 500).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Wormly (e.g., change the Expected HTTP Response back to 200), verify that the incident in Callgoose SQIBS is automatically marked as resolved.

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

8. Conclusion

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

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