Aha

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Integration Steps

• Log in to Aha
• Use your credentials to log in to your Aha account.
• Set Up Your Environment
• Create or configure your environment/workspace as necessary to access the Aha dashboard. Ensure you’re in the correct workspace where the integration will be applied.
• Access Workspace Settings
• On the Aha dashboard, locate and click the settings icon (typically a gear icon).
• From the settings menu, select "Workspace".
• Navigate to Integrations
• Scroll down the workspace settings page until you find the "Integrations" section.
• Click the plus icon (+) to add a new integration.
• Select a Webhook Type
• Scroll down to view the available webhook options:
• Activity Webhook: Sends all workspace or account activity to a generic HTTP webhook. All activity will be sent via an HTTP POST to the URL specified in the "Hook URL" parameter.
• Integration Webhook: Sends data when a user selects "Send to Webhook" from the "Send" dropdown next to the Integrations field for a feature or release. An HTTP POST will be made to the URL specified in the "Hook URL" parameter.
• Choose the webhook type that aligns with your needs:
• Use Activity Webhook for comprehensive activity tracking.
• Use Integration Webhook for targeted data from specific features or releases.
• Configure the Webhook
• In the webhook configuration form, locate the "Hook URL" field.
• Paste the Callgoose SQIBS API endpoint URL into this field. Ensure the URL is correct and properly formatted. For more details, see Callgoose API Endpoint Documentation.
• Enable the Webhook
• Select the "Enable" option to activate the webhook.
• Complete the Integration
• Save the configuration. The integration is now set up, and data will begin flowing to Callgoose SQIBS based on the selected webhook type.

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

4.1.1 Example JSON Payloads from Aha

Alert Triggered

json

{
	"event":"audit",
	"audit":{
		"id":"7486747259601627325",
		"audit_action":"create",
		"created_at":"2025-03-28T06:43:03.326Z",
		"interesting":false,
		"user":{
			"id":"7486726171630203891",
			"name":"****",
			"email":"****",
			"created_at":"2025-03-28T05:21:13.401Z",
			"updated_at":"2025-03-28T06:42:38.366Z"
		},
		"contributors":[
			{
				"user":{
					"id":"7486726171630203891",
					"name":"****",
					"email":"****",
					"created_at":"2025-03-28T05:21:13.401Z",
					"updated_at":"2025-03-28T06:42:38.366Z"
				}
			}
		],
		"auditable_type":"capacity_scenario",
		"auditable_id":"7486747259577489247",
		"description":"added capacity scenario Default scenario",
		"changes":[
			{
				"field_name":"Name",
				"value":"Default scenario"
			}
		]
	}
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Aha 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: "event"
• Key Value Contains: null
• Map Incident With: null
• Incident Title From: "audit"."auditable_type"
• 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 "audit"."description" key in the Incident Description From field, the incident description will be the value of the "audit"."description" key. In the example JSON payload provided earlier, this would result in a description like "added capacity scenario Default scenario".
• 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 Aha.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Aha that causes an alert (e.g., Update your workspace settings or add new feature).
• 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.
• Aha Permissions: Confirm that the webhook in Aha 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 Aha 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 Aha matches the expected structure.

8. Conclusion

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

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