Codemagic

Overview

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

Prerequisites

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

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.

1. Generate an API Token:

• Follow the guide on How to Create API Token in Callgoose SQIBS.

1. Find the API Endpoint:

• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from Codemagic will be sent.

2. Debugging and Troubleshooting

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

To configure Codemagic to generate the JSON payloads similar to the examples provided, follow the steps outlined below. These steps will guide you through setting up the necessary alerts and webhook notifications within Codemagic to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Alerts in Codemagic

To generate the required JSON payloads, you first need to set up alerts within Codemagic.

1. Log in to the Codemagic Console:

• Access the Codemagic platform using your account credentials.

1. Navigate to the Alerts Section:

• In the Codemagic console, go to the appropriate section for setting up build alerts or monitoring.

1. Create a New Alert:

• Define the conditions that will trigger the alert, such as build failures, test failures, or any other custom metrics.
• Set up a Webhook as the notification method.

1. Configure the Webhook URL:

• Use the endpoint provided by Callgoose SQIBS.

3.2 Configuring the Webhook Notification

To ensure that the JSON payload sent matches the examples provided, follow these steps when configuring the webhook:

1. Add Webhook URL:

• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

1. Customize Payload Format:

• Ensure that the payload includes key fields like "status", "build", "message", "project", and others as shown in the example payloads.

1. Test the Webhook Configuration:

• Before activating the webhook, perform a test to ensure that the JSON payload is correctly formatted and is being sent to the Callgoose SQIBS API endpoint as expected.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

3.3 Finalizing and Testing

1. Save and Activate the Alert:

• Once the alert and webhook are correctly configured, save the alert configuration and activate it.

1. 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.

1. Additional Considerations:

• Permissions: Ensure that the webhook has the necessary permissions to send alerts to the Callgoose SQIBS API endpoint.
• Security: Implement security measures such as HTTPS and API tokens to protect the data being transmitted between Codemagic and Callgoose SQIBS.
• Logging and Debugging: Use the debugging and logging features in Callgoose SQIBS to monitor incoming payloads and troubleshoot any issues with the integration.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from Codemagic

Alert Triggered (status: "FAILED")

json

{
  "build": {
    "id": "build123",
    "status": "FAILED",
    "message": "Build failed due to error in the test phase",
    "project": "MyProject",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

Alert Resolved (status: "SUCCESS")

json

{
  "build": {
    "id": "build123",
    "status": "SUCCESS",
    "message": "Build succeeded after error resolution",
    "project": "MyProject",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Codemagic 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: ["FAILED", "ERROR"]
• Map Incident With: "build.id"
• This corresponds to the unique build.id from the Codemagic payload.
• Incident Title From: "build.message"
• This will use the build message as the incident title in Callgoose SQIBS.
• 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 "message" key in the Incident Description From field, the incident description will be the value of the "message" key. In the example JSON payload provided earlier, this would result in a description like "Build failed due to error in the test phase".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: ["SUCCESS"]
• Incident Mapped With: "build.id"
• This ensures the incident tied to the specific build.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

1. 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 Codemagic.

1. Test the Integration:

• Manually trigger an alert in Codemagic to test if incidents are created in Callgoose SQIBS.
• Verify that the incident appears in Callgoose SQIBS with the correct title, description, and mapped values.
• Resolve the alert in Codemagic and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Alerts

1. Simulate a Build Failure:

• Trigger a condition in Codemagic that causes an alert, such as a build failure or error during execution.
• Verify that an incident is created in Callgoose SQIBS with the correct information, including the title, description, and any mapped values as configured in your API filters.

5.2 Resolving Alerts

1. Acknowledge and Resolve the Alert:

• Once the issue that caused the alert in Codemagic is resolved (e.g., a successful build after fixing the issue), verify that the corresponding incident in Callgoose SQIBS is automatically marked as resolved.

1. Review Incident Closure:

• Confirm that the incident in Callgoose SQIBS reflects the resolved status, including any relevant details such as resolution time and any updates to the incident description.

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 to prevent unauthorized access.
• Codemagic Permissions: Confirm that the webhook in Codemagic has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between Codemagic and Callgoose SQIBS is encrypted, especially if sensitive information is involved.

7. Troubleshooting

• No Incident Created: If no incident is created in Callgoose SQIBS, verify that the webhook URL in Codemagic 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 Codemagic matches the expected structure.
• Debugging: Use the API log in Callgoose SQIBS to check for any errors or issues in the received payload and to verify that the webhook is functioning as expected.

8. Conclusion

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

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