Integrations
Sedai
Overview
This document describes how to integrate Sedai with Callgoose SQIBS. The integration utilizes Sedai's Notification integration feature to send autonomous cloud management alerts (such as availability risks, performance issues, and remediation events) to Callgoose SQIBS via Webhook. Callgoose API Filters then ingest these JSON payloads to automatically create and resolve incidents.
Prerequisites
- A Sedai account with permissions to configure Settings > Integrations.
- A Callgoose SQIBS account with permission to create API Tokens and API Filters.
- A reachable HTTPS endpoint for Callgoose (your Callgoose API Endpoint + token).
1. Install Sedai
Sedai is a SaaS platform. No local installation is required for webhook integrations. All configuration is performed within the Sedai console.
2. Obtain the Callgoose SQIBS Webhook URL
- In Callgoose SQIBS: generate or locate the API Endpoint used to receive incoming events.
- Copy the full endpoint URL. It typically follows this format: https://****.callgoose.com/v1/process?from=Sedai&token=xxxx
3. Create the Sedai → Callgoose Webhook Integration
- Log in to your Sedai console.
- Navigate to Settings > Integrations.
- Click the Add Integration button in the upper right-hand corner.
- Select Notifications from the list of integration categories.
- Choose Webhook as the provider type.
- Configure the integration details:
- Name: Enter Callgoose SQIBS.
- URL: Paste the Callgoose Webhook URL obtained in Step 2.
- Method: Select POST.
- Format: Ensure JSON is selected.
- Click Save to complete the setup.
- (Optional) Ensure this new integration is enabled for the specific Notification Groups or Applications you wish to monitor.
4. Define Notification Scopes in Sedai
After creating the integration, ensure it is subscribed to the relevant events:
- Navigate to Settings > Notifications (or the Notifications tab within specific Account settings).
- Locate the alert categories you wish to route to Callgoose (e.g., Availability, Performance, Cost, Remediation).
- Add the Callgoose SQIBS webhook integration you created in Step 3 as a destination for these alerts.
5. Example Sedai Webhook Payloads
Sedai sends notification payloads in JSON format. The structure may vary depending on whether the event is an optimization recommendation, a remediation action, or an availability issue.
Important: The examples below are representative. You must inspect the actual payload in the Callgoose API Logs to ensure you map the exact keys generated by your specific Sedai version and configuration.
5.1. Example Payload (Trigger / Open Incident)
This payload represents a new issue detected by Sedai (e.g., High Error Rate).
JSON
{
"eventId": "evt-839201",
"eventType": "Availability",
"title": "High Error Rate Detected",
"message": "Error rate for service 'checkout-api' exceeded 5% threshold.",
"severity": "CRITICAL",
"status": "OPEN",
"resource": {
"name": "checkout-api",
"type": "Kubernetes Service",
"region": "us-west-2"
},
"timestamp": "2023-11-15T10:00:00Z",
"link": "https://dashboard.sedai.io/events/evt-839201"
}
5.2. Example Payload (Resolve Incident)
This payload represents the resolution of the issue, either via autonomous remediation or manual recovery.
JSON
{
"eventId": "evt-839201",
"eventType": "Availability",
"title": "High Error Rate Detected",
"message": "Error rate for service 'checkout-api' has returned to normal levels.",
"severity": "INFO",
"status": "RESOLVED",
"resource": {
"name": "checkout-api",
"type": "Kubernetes Service",
"region": "us-west-2"
},
"timestamp": "2023-11-15T10:15:00Z",
"resolvedAt": "2023-11-15T10:15:00Z"
}
6. Configure API Filters in Callgoose SQIBS
To process the incoming Sedai webhooks, you must create API Filters in Callgoose to map the JSON fields to Incident attributes.
6.1. Trigger Filter — Create Incident
This filter creates a new incident when Sedai sends an alert.
- Payload Key: "status"
- Value Contains: OPEN (or FIRING / CRITICAL)
- Map Incident With: "eventId" (This is critical for deduplication).
- Incident Title: "title"
- Incident Description: "message"
6.2. Resolve Filter — Auto-Resolve Incident
This filter automatically resolves the incident in Callgoose when Sedai sends a resolution notification.
- Payload Key: "status"
- Value Contains: RESOLVED (or CLOSED / OK)
- Map Incident With: "eventId" (Must match the key used in the Trigger Filter).
7. Testing the Integration
- Trigger a Test Event:
- If Sedai provides a "Test" button in the Integration settings, use it to send a sample payload.
- Alternatively, wait for a scheduled optimization or trigger a mock alert in a non-production environment.
- Verify Reception in Callgoose:
- Go to Callgoose SQIBS > Logs > API Log.
- Confirm that a POST request from Sedai was received with a 200 OK status.
- Inspect and Refine:
- Click on the log entry to view the Body.
- Verify that the keys (e.g., eventId, title, status) match your API Filter configuration exactly.
- Confirm Incident Creation and Resolution:
- Check the Incidents dashboard to ensure the alert created a valid incident.
- Trigger a resolution event in Sedai and confirm the incident in Callgoose is automatically resolved.
8. Troubleshooting
- No Payload Received:
- Verify the Webhook URL in Sedai Settings is correct and includes the token.
- Ensure the integration is assigned to an active Notification Group in Sedai.
- Incidents Not Created:
- Inspect the API Log in Callgoose.
- Compare the JSON keys in the log against your Trigger Filter configuration. Field names are case-sensitive.
- Incidents Not Auto-Resolving:
- Confirm that Sedai sends a distinct "Resolved" event with the same eventId (or unique identifier) used in the creation event.
- Ensure the Map Incident With field is consistent across both Trigger and Resolve filters.
9. Security Considerations
- Token Privacy: Keep your Callgoose API Token secret. Do not share it in public forums or version control systems.
- HTTPS: Always use https:// for the Webhook URL to ensure payload data is encrypted in transit.
- Access Control: Limit access to the Settings > Integrations menu in Sedai to authorized administrators only.
10. Conclusion
Integrating Sedai with Callgoose SQIBS ensures that your team is immediately notified of critical cloud management events, availability risks, and optimization opportunities. By automating incident creation via Callgoose API Filters, you can reduce response times and maintain optimal cloud performance.
For further customization or advanced use cases, refer to the official documentation for both Sedai and Callgoose SQIBS:
