Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting up Bugsee

• Log In to Bugsee:
• Log in to your Bugsee account at Bugsee Console using your credentials.
• Connect Your Application to Bugsee
• If you haven’t connected your application to Bugsee yet, follow the Bugsee Application Setup Guide for detailed instructions on how to link your application to the Bugsee platform.
• Once your application is connected, you’ll be able to monitor crash reports, bugs, and error reports generated by your app.

3.2 Configuring the Webhook Notification

• Navigate to Administration option.
• Select the Webhooks option and click on it.
• Click Add Webhook.
• Enter the API Endpoint URL provided by Callgoose SQIBS. Refer to the API Endpoint documentation for more details on selecting the final endpoint format.
• Click Next. You will now see different events available for triggering notifications, such as "New issue reported" or "Issue updated." Choose the appropriate events and click Next.
• Select the application for which you want to activate the webhook and save your settings.

3.3 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.
• To test, click on the three dots next to the created webhook and select the test option.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

3.4 Finalizing and Testing

• Validate the Integration:
• Trigger the 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.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from Bugsee

New issue reported

Alert Triggerd(state:”open”)

json

{
  "id": "d6Gg0ftAW",
  "type": "issue.created",
  "created_on": "2024-09-09T10:53:24.033Z",
  "payload": {
    "app": {
      "key": "TEST_APP",
      "name": "Test name",
      "url": ""
    },
    "issue": {
      "key": "TEST_ISSUE",
      "summary": "Test summary",
      "description": "Test description",
      "type": "bug",
      "state": "open",
      "labels": [],
      "url": "",
      "severity": "high",
      "created_on": "2024-09-09T10:53:24.033Z",
      "updated_on": "2024-09-09T10:53:24.033Z",
      "created_by": {
        "name": "Test user",
        "email": "test@user.com"
      },
      "recordings": [
        {
          "key": "000000000",
          "url": "",
          "environment": {
            "app": {
              "locale": "en_US",
              "debuggable": true,
              "package_id": "com.sample",
              "version": "1",
              "build": "1",
              "debugger_attached": false
            },
            "platform": {
              "locale_extended_info": {},
              "supported_abis": [],
              "locale": "en_US",
              "jailbreak": false,
              "disk_total": 823,
              "version": "22",
              "disk_free": 48,
              "release_name": "5.1.1",
              "type": "android"
            },
            "hardware": {
              "network": {},
              "screen": {},
              "battery": 100,
              "android_id": "",
              "carrier": "Android",
              "model_name": "Android SDK built for x86",
              "model": "Android SDK built for x86",
              "device_id": "2123dc84-5867-4ca5-8ce3-3be9788f6ace",
              "charging": true,
              "manufacturer": "unknown"
            }
          },
          "created_on": "2024-09-09T10:53:24.033Z",
          "updated_on": "2024-09-09T10:53:24.033Z",
          "created_by": {
            "name": "Test user",
            "email": "test@user.com"
          }
        }
      ]
    }
  }
}

Alert Resolved(state:”closed”)

json

{
  "id": "Ht4ATTc7E",
  "type": "issue.closed",
  "created_on": "2024-09-09T10:54:47.687Z",
  "payload": {
    "app": {
      "key": "TEST_APP",
      "name": "Test name",
      "url": ""
    },
    "issue": {
      "key": "TEST_ISSUE",
      "summary": "Test summary",
      "description": "Test description",
      "type": "bug",
      "state": "closed",
      "labels": [],
      "url": "",
      "severity": "high",
      "created_on": "2024-09-09T10:54:47.687Z",
      "updated_on": "2024-09-09T10:54:47.687Z",
      "closed_on": "2024-09-09T10:54:47.687Z",
      "closed_by": {
        "name": "Test user",
        "email": "test@user.com"
      },
      "recordings": []
    }
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Bugsee 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: "payload"."issue"."state"
• Key Value Contains: [open]
• Map Incident With: "payload"."app"."key"
• This corresponds to the unique payload app key from the Bugsee payload.
• Incident Title From: "type"
• This will use the issue type as the incident title in Callgoose SQIBS.
• The title of the incident can also be managed using the 'callgoose sqibs' API endpoint. Refer to the API Endpoint Documentation for more details.
• 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 "payload"."issue"."summary" key in the Incident Description From field, the issue summary will be the value. In the example JSON payload provided earlier, this would result in a description like "Test summary".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "payload"."issue"."state"
• Key Value Contains: [closed]
• Incident Mapped With: "payload"."app"."key"
• This ensures the incident tied to the specific payload app key is resolved when the alert status returns to normal.

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

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Bugsee that causes an alert (e.g., an app issue created).
• Verify that an incident is created in Callgoose SQIBS with the correct information, including the title, description, and urgency level.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Bugsee (e.g., an app issue closed), 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.
• Bugsee Permissions: Confirm that the webhook in Bugsee 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 Bugsee 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 Bugsee matches the expected structure.

8. Conclusion

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

• Bugsee Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API