Visualping

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Job and Webhook in Visualping

• Log in to Visualping
• Go to Visualping.
• Enter your credentials and log in to your account.
• Create a New Monitoring Job
• Click on the New Job button on the Visualping dashboard.
• In the Enter a Website field, paste the URL of the website you want to monitor.
• Configure Job Details
• Provide a name for the job (e.g., "Homepage Monitoring").
• Add a brief description of the job.
• Select how often Visualping should check for changes
• Choose the comparison type based on your needs: Visual, Text etc.
• If required, configure specific actions for the job.
• Set Up Notifications
• Navigate to the Notifications section.
• Select the Webhook option.
• Paste the Webhook Endpoint URL provided by Callgoose SQIBS.
• Refer to the Callgoose SQIBS API Documentation for the correct endpoint format.
• Schedule the Job
• Set the schedule based on your requirements.
• Review the job configuration.
• Create the Job
• Click the Create Job button to finalize the setup.
• Visualping will now monitor the website and send notifications to Callgoose SQIBS via the configured webhook.

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

4.1.1 Example JSON Payloads from Visualping

Alert Triggered

json

{
  "job_id": 5999749,
  "workspace_id": 42521,
  "workspace_name": "📗 Workspace #1",
  "url": "https://in.investing.com/charts/cryptocurrency-charts",
  "description": "MGU",
  "datetime": "Fri Nov 15 2024 05:08:04 GMT+0000 (Coordinated Universal Time)",
  "original": "https://s3.us-west-2.amazonaws.com/vp-files-ore/resources/3months/aeyiw-DO4EdGJKKUpH28htu0YLo.png",
  "current": "https://s3.us-west-2.amazonaws.com/vp-files-ore/resources/3months/q69QXQARyJ86Aol-7TSgOfwEZ_o.png",
  "preview": "https://vp-files-ore.s3.us-west-2.amazonaws.com/resources/3months/163983cf-d744-47ff-b9c2-1647169e0816.png",
  "change": "14.711538461538462 %",
  "view_changes": "https://visualping.io/autologin?redirect=%2Fjobs%2F5999749%3Fmode%3Dtext",
  "text_changes": "https://s3.us-west-2.amazonaws.com/vp-files-ore/resources/3months/q69QXQARyJ86Aol-7TSgOfwEZ_o_diff.html",
  "added_text": "(UTC+5:30) % log auto Date Range 10y 3y 1y 1m 7d 1d Go to... Market Open DOGE/USD, 15, Binance O 0.358700 H 0.361380 L 0.358700 C 0.361380 5 15 1h 1D 1M 15  Watchlist Symbol Last Chng (%) DOGE/USD Market Open C BTC/USD Market Open C PEPE/USD Market Open C DOGE/USD Market Open C ETH/USD Market Open C XRP/USD Market Open 0.8049 C +0.1050 +15.00% BTC/USD Market Open C ADA/USD Market Open C SOL/USD Market Open C SHIB/INR Market Open C ETH/USD Market Open C DOGE/INR Market Open C SHIB/USD Market ...",
  "removed_text": "933; 20; 16; 0; 27; 709; 111; 10",
  "summarizer": "The market data for DOGE/USD and other cryptocurrencies has been updated, showing a slight increase in DOGE/USD to 0.361380, while the overall market value has risen from 5,933.20 to 5,935.70.",
  "important": "no analyzer call"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Visualping 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: "important"
• Key Value Contains: null
• Map Incident With: null
• Incident Title From: "important"
• 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 "summarizer" key in the Incident Description From field, the incident description will be the value of the "summarizer" key. In the example JSON payload provided earlier, this would result in a description like "The market data for DOGE/USD and other cryptocurrencies has been updated, showing a slight increase in DOGE/USD to 0.361380, while the overall market value has risen from 5,933.20 to 5,935.70.".
• 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.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 Visualping.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Visualping that causes an alert (e.g., Make any changes in the monitored website).
• 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.
• Visualping Permissions: Confirm that the webhook in Visualping 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 Visualping 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 Visualping matches the expected structure.

8. Conclusion

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

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