Bitrise

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

To configure Bitrise 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 Bitrise to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Alerts in Bitrise

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

• Log in to the Bitrise Console:
• Access the Bitrise platform using your account credentials.
• Navigate to the App Settings:
• Go to the settings of the app for which you want to set up alerts.
• Create a New Webhook:
• Under the 'Webhook' section, click on 'Add Webhook'.
• Specify the Webhook URL: Enter the webhook URL provided by Callgoose SQIBS.
• Configure the Trigger Conditions:
• Define the conditions that will trigger the webhook, such as build failures, successes, or specific workflow completions.

3.2 Configuring the Webhook Notification

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

• Add Webhook URL:
• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.
• Customize Payload Format:
• Ensure that the payload includes key fields like "status", "build_slug", "workflow", "app_slug", and others as shown in the example payloads.
• Example Payload Setup:

json

{
  "event": "build_finished",
  "status": "$STATUS",
  "build_slug": "$BUILD_SLUG",
  "workflow": "$WORKFLOW",
  "app_slug": "$APP_SLUG",
  "timestamp": "$TIMESTAMP"
}

• Placeholder Explanation:
• "$STATUS": Replaces with the status of the build (e.g., success, failed).
• "$BUILD_SLUG": A unique identifier for the build.
• "$WORKFLOW": The workflow that was run.
• "$APP_SLUG": The unique identifier for the app.
• $TIMESTAMP": The time the event occurred.
• 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.
• Save and Activate the Webhook:
• Once the webhook is correctly configured and tested, save the configuration and activate it.
• Ensure that the webhook is active and set to trigger based on your specified conditions.
• 
  

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from Bitrise

Build Success (status: "success")

json

{
  "event": "build_finished",
  "status": "success",
  "build_slug": "build123",
  "workflow": "deploy",
  "app_slug": "app123",
  "timestamp": "2024-08-05T12:00:00.000Z"
}

Build Failure (status: "failed")

json

{
  "event": "build_finished",
  "status": "failed",
  "build_slug": "build124",
  "workflow": "test",
  "app_slug": "app123",
  "timestamp": "2024-08-05T12:15:00.000Z"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Bitrise 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"]
• Map Incident With: "build_slug"
• This corresponds to the unique build_slug from the Bitrise payload.
• Incident Title From: "workflow"
• This will use the workflow name 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 "status" key in the Incident Description From field, the incident description will be the value of the "status" key. In the example JSON payload provided earlier, this would result in a description like "failed".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: ["success"]
• Incident Mapped With: "build_slug"
• This ensures the incident tied to the specific build_slug is resolved when the build status returns to success.

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 Bitrise.
• Test the Integration:
• Manually trigger a build in Bitrise 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 build in Bitrise and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Build Failure:
• Trigger a build in Bitrise that fails (e.g., by introducing a deliberate error in the code).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the build is successful in Bitrise, verify that the incident in Callgoose SQIBS is automatically marked as resolved.

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

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in Bitrise 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 Bitrise matches the expected structure.

8. Conclusion

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

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