Uptime.com

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting up Webhook Integration in Uptime.com

• Login to Uptime
• Open Uptime.com and log in using your credentials.
• Navigate to Notifications
• Once logged in, click on the Notifications tab.
• Access Integrations
• In the Notifications section, click on the Integrations option.
• Add a New Integration Profile
• Click on Add Integration Profile to create a new integration.
• In the integration options, select Custom Postback URL (Webhook) to configure a webhook integration.
• Enter a meaningful name for your integration in the Name field.
• In the Assign to Contacts field, choose Default to assign this integration to default contacts.
• In the URL field, paste the endpoint URL provided by Callgoose SQIBS.
• If you want a minimal and concise payload, check the Legacy Payload option.
• If you require the full payload, uncheck this option.
• Save the Integration
• After filling in all necessary details, click Save to complete the integration setup.
• Test the Integration
• Once saved, click on Start Test to send a test payload to the Callgoose SQIBS.
• You can view the test payload by checking the API Log in the Callgoose SQIBS.

3.2 Setting up Monitor in Uptime.com

• Go to the Dashboard
• Navigate to the Dashboard in Uptime.
• Monitor an Entire Site
• Click on the Monitor Entire Site option.
• Paste the URL of the website you wish to monitor in the provided field and click Go.
• Once the site is added, You can choose the checks manually or can select all checks.
• You can also add new checks as needed to further customize the monitoring process.
• After adding checks click on the created check.
• Click on Edit Check and ensure that the Contact field is set to Default, as we assigned the contact as Default while creating the webhook.

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

4.1.1 Example JSON Payloads from Uptime.com

Alert Triggered (state_is_up: "false")

json

{
  "date": "Oct. 18, 2024, 9:50 a.m. UTC",
  "alert_history_url": "https://uptime.com/alerting/alert-history?service_id=****",
  "server_name": "aquinascollege.co.in",
  "check_name": "Test",
  "check_full_name": "aquinascollege.co.in / Test",
  "check_type": "HTTP(S)",
  "check_id": ****,
  "check_url": "https://aquinascollege.co.in/adms",
  "state_is_up": false,
  "output": "HTTP WARNING: HTTP/2 404 - 189 bytes in 0.161 second response time\n\ntime=0.161387s;;;0.000000;40.000000 size=189B;;;0;",
  "site_url": "https://uptime.com",
  "downtime": "",
  "locations": [
    "US-NY-New York",
    "US-TX-Dallas"
  ]
}

Alert Resolved (state_is_up: "true")

json

{
  "date": "Oct. 18, 2024, 10:03 a.m. UTC",
  "alert_history_url": "https://uptime.com/alerting/alert-history?service_id=****",
  "server_name": "aquinascollege.co.in",
  "check_name": "Test",
  "check_full_name": "aquinascollege.co.in / Test",
  "check_type": "HTTP(S)",
  "check_id": ****,
  "check_url": "https://aquinascollege.co.in",
  "state_is_up": true,
  "output": "HTTP OK: HTTP/2 200 - 255 bytes in 0.797 second response time\n\ntime=0.796859s;;;0.000000;40.000000 size=255B;;;0;",
  "site_url": "https://uptime.com",
  "downtime": {
    "globalalertstate_id": 193311227,
    "started_at": "2024-10-18T09:50:47.739Z",
    "ended_at": "2024-10-18T10:03:05.069Z",
    "duration": 737.330269
  },
  "locations": ""
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Uptime.com 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: "state_is_up"
• Key Value Contains: [false]
• Map Incident With: "check_id"
• This corresponds to the unique check_id from the Uptime.com payload.
• Incident Title From: "check_full_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 "output" key in the Incident Description From field, the incident description will be the value of the "output" key. In the example JSON payload provided earlier, this would result in a description like "HTTP WARNING: HTTP/2 404 - 189 bytes in 0.161 second response time\n\ntime=0.161387s;;;0.000000;40.000000 size=189B;;;0;".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "state_is_up"
• Key Value Contains: [true]
• Incident Mapped With: "check_id"
• This ensures the incident tied to the specific check_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 Uptime.com.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Uptime.com that causes an alert (e.g., e.g., temporarily take down a web server or block the website’s IP).
• 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 Uptime.com (e.g., by restoring the server), 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.
• Uptime.com Permissions: Confirm that the webhook in Uptime.com 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 Uptime.com 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 Uptime.com matches the expected structure.

8. Conclusion

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

• Uptime.com 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 Uptime.com.