Calibre

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Webhook Notification in Calibre

• Log in to Calibre
• Navigate to the Calibre platform.
• Enter your login credentials and access your dashboard.
• Track a New Site
• On the dashboard, click on Track New Site.
• Configure the website you want to monitor by following the on-screen instructions.
• Save the configuration and click Start Tracking.
• Access the Created Track
• Locate the newly created track on your dashboard.
• Click on the track to view its details.
• Navigate to Synthetics Settings
• Within the track view, go to the Settings section.
• Under Synthetics, click on Integrations.
• Add a Webhook
• In the Integrations section, select Add a Webhook.
• Paste the URL endpoint provided by Callgoose SQIBS. The final API endpoint may vary depending on authentication and URL parameters. Ensure you retrieve the accurate endpoint from Callgoose SQIBS API Endpoint Documentation.
• Configure Event Alerts
• Choose the events you want to receive alerts for. Example: Snapshot Notifications.
• Select the relevant event types from the list provided.
• Save the Configuration
• Click Save to finalize the integration.

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.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from Calibre

Alert Triggered (status: "completed")

json

{
	"id":4,
	"generated_at":"2024-12-13T08:55:04Z",
	"organisation_id":"zebronx",
	"site_id":"mgu",
	"primary_region_id":"us-east-1",
	"ref":null,
	"client":"web",
	"status":"completed",
	"html_url":"https://calibreapp.com/teams/zebronx-developers/mgu/snapshots#4",
	"url":"https://calibreapp.com/api/sites/mgu/snapshots/4.json",
	"created_at":"2024-12-13T08:54:09.721Z",
	"pages":[
		{
			"uuid":"0bdfe2d6-1a12-4568-a861-3dfe12a1456b",
			"name":"Home",
			"status":"completed",
			"endpoint":"https://mgu.ac.in",
			"canonical":false,
			"profile":"Mobile",
			"profile_uuid":"03773dfc-9f8a-46f1-96ba-c25bbb3275ec",
			"metrics":[
				{
					"name":"third_party_main_thread_duration",
					"label":"Total Third Party Main Thread Execution Time",
					"value":534,
					"formatted_value":"534ms",
					"formatter":"humanDuration"
				},
				{
					"name":"third_party_size_in_bytes",
					"label":"Total Third Party Code Transferred",
					"value":141083,
					"formatted_value":"138 KB",
					"formatter":"fileSize"
				},
				{
					"name":"visually_complete",
					"label":"Visually Complete",
					"value":20800,
					"formatted_value":"20.8s",
					"formatter":"humanDuration"
				},
				{
					"name":"asset_count",
					"label":"Number of Requests",
					"value":34,
					"formatted_value":"34",
					"formatter":"trust"
				},
				{
					"name":"page_body_size_in_bytes",
					"label":"Total Page Size in Bytes",
					"value":31238921,
					"formatted_value":"29.8 MB",
					"formatter":"fileSize"
				},
				{
					"name":"page_size_in_bytes",
					"label":"Total Page Transferred",
					"value":718974,
					"formatted_value":"702 KB",
					"formatter":"fileSize"
				},
				{
					"name":"html_body_size_in_bytes",
					"label":"Total HTML Size in Bytes",
					"value":62658,
					"formatted_value":"61.2 KB",
					"formatter":"fileSize"
				},
				{
					"name":"html_size_in_bytes",
					"label":"Total HTML Transferred",
					"value":56014,
					"formatted_value":"54.7 KB",
					"formatter":"fileSize"
				},
				{
					"name":"css_body_size_in_bytes",
					"label":"Total CSS Size in Bytes",
					"value":420125,
					"formatted_value":"410 KB",
					"formatter":"fileSize"
				},
				{
					"name":"css_size_in_bytes",
					"label":"Total CSS Transferred",
					"value":76180,
					"formatted_value":"74.4 KB",
					"formatter":"fileSize"
				},
				{
					"name":"js_body_size_in_bytes",
					"label":"Total JavaScript Size in Bytes",
					"value":706447,
					"formatted_value":"690 KB",
					"formatter":"fileSize"
				},
				{
					"name":"js_size_in_bytes",
					"label":"Total JavaScript Transferred",
					"value":221093,
					"formatted_value":"216 KB",
					"formatter":"fileSize"
				},
				{
					"name":"font_body_size_in_bytes",
					"label":"Total Font Size in Bytes",
					"value":421464,
					"formatted_value":"412 KB",
					"formatter":"fileSize"
				},
				{
					"name":"font_size_in_bytes",
					"label":"Total Font Transferred",
					"value":193441,
					"formatted_value":"189 KB",
					"formatter":"fileSize"
				},
				{
					"name":"json_body_size_in_bytes",
					"label":"Total JSON Size in Bytes",
					"value":0,
					"formatted_value":"0 Bytes",
					"formatter":"fileSize"
				},
				{
					"name":"json_size_in_bytes",
					"label":"Total JSON Transferred",
					"value":0,
					"formatted_value":"0 Bytes",
					"formatter":"fileSize"
				},
				{
					"name":"image_body_size_in_bytes",
					"label":"Total Image Size in Bytes",
					"value":170449,
					"formatted_value":"166 KB",
					"formatter":"fileSize"
				},
				{
					"name":"image_size_in_bytes",
					"label":"Total Image Transferred",
					"value":172026,
					"formatted_value":"168 KB",
					"formatter":"fileSize"
				},
				{
					"name":"video_body_size_in_bytes",
					"label":"Total Video Size in Bytes",
					"value":29457778,
					"formatted_value":"28.1 MB",
					"formatter":"fileSize"
				},
				{
					"name":"video_size_in_bytes",
					"label":"Total Video Transferred",
					"value":220,
					"formatted_value":"220 Bytes",
					"formatter":"fileSize"
				},
				{
					"name":"page_tcp_timing",
					"label":"Server Connection Time",
					"value":505,
					"formatted_value":"505ms",
					"formatter":"humanDuration"
				},
				{
					"name":"page_dns_timing",
					"label":"Domain Lookup Time",
					"value":0,
					"formatted_value":"0ms",
					"formatter":"humanDuration"
				},
				{
					"name":"page_download_timing",
					"label":"HTML Download Time",
					"value":0,
					"formatted_value":"0ms",
					"formatter":"humanDuration"
				},
				{
					"name":"page_ssl_timing",
					"label":"SSL Time",
					"value":253,
					"formatted_value":"253ms",
					"formatter":"humanDuration"
				},
				{
					"name":"page_wait_timing",
					"label":"Response Time",
					"value":7111,
					"formatted_value":"7.11s",
					"formatter":"humanDuration"
				},
				{
					"name":"benchmarkIndex",
					"label":"Benchmark Index",
					"value":1838,
					"formatted_value":"1,838",
					"formatter":"trust"
				},
				{
					"name":"testDuration",
					"label":"Test Duration",
					"value":34651,
					"formatted_value":"34.7s",
					"formatter":"humanDuration"
				},
				{
					"name":"lighthouse-performance-score",
					"label":"Lighthouse Performance Score",
					"value":54,
					"formatted_value":"54",
					"formatter":"gradeScore"
				},
				{
					"name":"lighthouse-accessibility-score",
					"label":"Lighthouse Accessibility Score",
					"value":72,
					"formatted_value":"72",
					"formatter":"gradeScore"
				},
				{
					"name":"lighthouse-seo-score",
					"label":"Lighthouse SEO Score",
					"value":77,
					"formatted_value":"77",
					"formatter":"gradeScore"
				},
				{
					"name":"first-contentful-paint",
					"label":"First Contentful Paint",
					"value":11535,
					"formatted_value":"11.5s",
					"formatter":"humanDuration"
				},
				{
					"name":"speed_index",
					"label":"Speed Index",
					"value":17903,
					"formatted_value":"17.9s",
					"formatter":"humanDuration"
				},
				{
					"name":"max-potential-fid",
					"label":"Max Potential First Input Delay",
					"value":59,
					"formatted_value":"59ms",
					"formatter":"humanDuration"
				},
				{
					"name":"largest_contentful_paint",
					"label":"Largest Contentful Paint",
					"value":12736,
					"formatted_value":"12.7s",
					"formatter":"humanDuration"
				},
				{
					"name":"cumulative-layout-shift",
					"label":"Cumulative Layout Shift",
					"value":63,
					"formatted_value":"0.063",
					"formatter":"milliunit"
				},
				{
					"name":"consistently-interactive",
					"label":"Time to Interactive",
					"value":12736,
					"formatted_value":"12.7s",
					"formatter":"humanDuration"
				},
				{
					"name":"total-blocking-time",
					"label":"Total Blocking Time",
					"value":9,
					"formatted_value":"9ms",
					"formatter":"humanDuration"
				},
				{
					"name":"js-parse-compile",
					"label":"JS Parse \u0026 Compile",
					"value":443,
					"formatted_value":"443ms",
					"formatter":"humanDuration"
				},
				{
					"name":"time-to-first-byte",
					"label":"Time to First Byte",
					"value":7195,
					"formatted_value":"7.2s",
					"formatter":"humanDuration"
				},
				{
					"name":"third_party_count",
					"label":"Number of Third Party Providers",
					"value":4,
					"formatted_value":"4",
					"formatter":"trust"
				}
			],
			"budget_alerts":null,
			"artifacts":{
				"screenshot":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/screenshot/screenshot.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=0329051339d9873c0936990a776bb39e3040ddfe9c8d4248c7dcbde44ee8323c",
				"filmstrip":{
					"thumbs":[
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-89938d27d3dbc799b2b80101776f4d3c.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=99c72749f2b08ef50b440a2e197115de5bce7c29719f5f85f7af676dbe95d4f1",
							"timing":2080,
							"timestamp":2887729932,
							"fileSize":266,
							"hash":"89938d27d3dbc799b2b80101776f4d3c"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-89938d27d3dbc799b2b80101776f4d3c.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=99c72749f2b08ef50b440a2e197115de5bce7c29719f5f85f7af676dbe95d4f1",
							"timing":4160,
							"timestamp":2889809932,
							"fileSize":0,
							"hash":"89938d27d3dbc799b2b80101776f4d3c"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-89938d27d3dbc799b2b80101776f4d3c.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=99c72749f2b08ef50b440a2e197115de5bce7c29719f5f85f7af676dbe95d4f1",
							"timing":6240,
							"timestamp":2891889932,
							"fileSize":0,
							"hash":"89938d27d3dbc799b2b80101776f4d3c"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-a652fb5985ec284f50874aa16c4ebc5a.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=863e2abdfaf3106a117f6a0897a40d9f43265d142c6923a366ddca4853878e2b",
							"timing":8320,
							"timestamp":2893969932,
							"fileSize":5276,
							"hash":"a652fb5985ec284f50874aa16c4ebc5a"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-30fd0f700fd874dfc4744e83ef21e4e2.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=f5e78e95812859ffe4c17a965d856dfa061f856af54405d03dd969b7f68e2b73",
							"timing":10400,
							"timestamp":2896049932,
							"fileSize":11742,
							"hash":"30fd0f700fd874dfc4744e83ef21e4e2"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-95bcc2a03ec3ba3840124cb0d5e91ab5.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=5e8cba0b67d1cefc1c9429553bede241deb8a3b5588b3fae85a3b0c6ea48239c",
							"timing":12480,
							"timestamp":2898129932,
							"fileSize":12030,
							"hash":"95bcc2a03ec3ba3840124cb0d5e91ab5"
						},
						{
							"url":"https://calibre-screenshots-prod.s3.amazonaws.com/8f53d0fb-443c-4108-9485-b1f51b5847dc/artifact/screenshot-95bcc2a03ec3ba3840124cb0d5e91ab5.webp?X-Amz-Expires=604800\u0026X-Amz-Date=20241213T085504Z\u0026X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=AKIAXYAYNSM3W47DQSMV%2F20241213%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=5e8cba0b67d1cefc1c9429553bede241deb8a3b5588b3fae85a3b0c6ea48239c",
							"timing":14560,
							"timestamp":2900209932,
							"fileSize":0,
							"hash":"95bcc2a03e"}]}}}]}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Calibre 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"
• Key Value Contains: [completed]
• Map Incident With: null
• Incident Title From: null
• 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.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: []
• 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 Calibre.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Calibre that causes an alert (e.g., When a snapshot is taken).
• 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.
• Calibre Permissions: Confirm that the webhook in Calibre 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 Calibre 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 Calibre matches the expected structure.

8. Conclusion

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

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