Semonto

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Step-by-Step Integration

• Log into Semonto
• Sign in using your Semonto credentials.
• Access your dashboard and settings to configure notifications.
• Navigate to Notifications
• Click on Notifications from the main menu.
• Begin setting up a new notification for your integration.
• Create a New Notification
• Click on Add Notification.
• Provide a descriptive name to help identify its purpose.
• Choose all the features you wish to be notified about (e.g., status changes, alerts).
• Configure Webhook Settings
• After clicking Add Notification, you will be redirected to a new page.
• Under the “Channels” Section:
• Click on the webhooks option.
• Toggle the webhook settings to activate them.
• Click on Add URL.
• Enter API Endpoint:
• Paste the API endpoint URL provided by Callgoose SQIBS.
• Note: The final API endpoint may vary based on authentication and additional URL parameters. Click here for more details.
• Save and Set Default Behavior
• Click Save to store the webhook configuration.
• In the General section on the same page, enable the Default Settings option.
• Ensures that any new monitor added to this notification will automatically inherit this configuration.
• Configure Your Monitor from the Dashboard
• Return to your Semonto dashboard.
• Add the monitor of your choice (e.g., server, website, or cron job).
• Configure the selected monitor according to your requirements.
• This final step completes the integration setup, ensuring that notifications flow from Callgoose SQIBS to Semonto as configured.

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.
• 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 Semonto alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Semonto

Alert Triggered (status_str: "error")

json

{
  "id": 17166,
  "type": "reachability",
  "status_str": "error",
  "status": 4,
  "name": "www.httpbin.org",
  "tests": [
    {
      "key": "reachability",
      "status": "4",
      "info": "1289.737147 | http: 404",
      "friendly_name": "Reachability (HTTP ping)",
      "status_str": "Error"
    }
  ],
  "test_date": 1739354672,
  "url": "https://www.httpbin.org",
  "ip_addresses": [
    "****"
  ]
}

Alert Resolved (status_str: "ok")

json

{
  "id": 17166,
  "type": "reachability",
  "status_str": "ok",
  "status": 0,
  "name": "www.httpbin.org",
  "tests": [
    {
      "key": "reachability",
      "status": 0,
      "info": "332.40641",
      "friendly_name": "Reachability (HTTP ping)",
      "status_str": "ok"
    }
  ],
  "test_date": 1739355350,
  "url": "https://www.httpbin.org",
  "ip_addresses": [
    "****"
  ]
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Semonto 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: "status_str"
• Key Value Contains: [error]
• Map Incident With: "id"
• This corresponds to the unique id from the Semonto payload.
• Incident Title From: "tests".[0]."friendly_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 "tests".[0]."info" key in the Incident Description From field, the incident description will be the value of the "tests".[0]."info" key. In the example JSON payload provided earlier, this would result in a description like "1289.737147 | http: 404".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status_str"
• Key Value Contains: [ok]
• Incident Mapped With: "id"
• This ensures the incident tied to the specific id 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 Semonto.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Semonto that causes an alert (e.g., when a server is down).
• 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 Semonto (e.g., when the server returns to a normal level), 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.
• Semonto Permissions: Confirm that the webhook in Semonto 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 Semonto 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 Semonto matches the expected structure.

8. Conclusion

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

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