Instabug

Overview

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

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

2. Debugging and Troubleshooting

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

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

3.1 Log in and Set Up Webhooks

• Log in to Instabug:
• Use your credentials to access the Instabug platform.
• Select your application:
• If you don't have an existing application, create one. After selecting the application, follow the steps below.
• Go to Integrations:
• In the settings menu, find and click on Integrations.
• Create a Webhook:
• Click on Create under the Webhooks section.
• Enter the Webhook URL:
• In the URL field, enter the API endpoint provided by Callgoose SQIBS. Ensure that the final endpoint format follows Callgoose’s specifications.
• Customize the Payload:
• Select the specific data you want to forward to the webhook, such as email, app version, device, location, etc.
• Continue and Test the Integration:
• After configuring the webhook, click on Continue. Test the integration to ensure that the setup is correct. You can check the test payload in the API log section of Callgoose SQIBS.
• Complete the Webhook Setup:
• Choose when the webhook should be forwarded. For example: A new bug, improvement or question is reported.
• Name the integration.
• If everything is configured correctly, click Continue

3.2 Create Custom Alerts and Rules

• Navigate to Alerts and Rules:
• From the home page, go to the Alerts and Rules section.
• Create a New Alert:
• Click on Create, then configure the trigger for the alert. For more information go to Alert Rules.
• Forward to Webhook:
• In the Then field, click on Forward it to and select the webhook you created.
• Save the Configuration:
• Save the alert after completing the setup.

3.3 Finalizing and Testing

• Validate the Integration:
• Trigger the 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 Instabug alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Instabug

Alert Triggered (Type: "bug")

json

{
  "Title": "This is a sample bug. Reported by Instabug.",
  "Reported At": "Wed, 28 May 2014 00:00:00 UTC +00:00",
  "Email": "noreply@instabug.com",
  "Categories": "",
  "Tags": "",
  "App Version": "5.11.0 (5.11.0.21884545)",
  "Device": "iPhone 4, iOS 7.0",
  "Location": "San Francisco, USA",
  "Duration": 8,
  "Screen Size": "320x568",
  "Density": "@2x",
  "User Attributes": {
    "UserAttributeAppDelegate": "UAAppDelegate"
  },
  "User Data": "You can attach extra data items with each bug reported. \n\n { \n\t userid = 721899; \n\t username = \"jack.edward\";\n }",
  "User Steps": "16:25:07 Application: SceneDidActivate\n16:25:07 Application: DidBecomeActive\n16:25:07 Top View: MyDemoApp.ProductsTableViewController\n16:39:25 Tap in UITableViewCellContentView in MyDemoApp.ProductsTableViewController\n16:39:25 Top View: MyDemoApp.ProductViewController\n16:39:26 Tap in UIButton in MyDemoApp.ProductViewController\n16:39:26 Top View: MyDemoApp.CheckoutViewController\n16:39:35 Shake in: MyDemoApp.CheckoutViewController",
  "Instabug Log": "You can also add your own log in production using our function IBGLog. \n\n 2014-03-25 16:19:00.111 AppDemo[69166:60b] ViewLoaded \n 2014-03-25 16:19:00.113 AppDemo[69166:60b] Request completed \n 2014-03-25 16:19:00.123 AppDemo[69166:60b] User isn't logged in \n 2014-03-25 16:19:00.213 AppDemo[69166:60b] Login view",
  "Console Log": "2017-01-30 21:45:23.674 assertion failed: 16D32 14C89: libxpc.dylib + 62677 [0339A402-6531-30E9-8BC2-589C463CD6D6]: 0x7d\n\n2017-01-30 21:45:53.631 Normal message received by listener connection. Ignoring.\n\n2017-01-30 21:45:53.631 Could not successfully update network info during initialization.\n\n2017-01-30 21:45:56.402 Normal message received by listener connection. Ignoring.\n\n2017-01-30 21:45:56.402 Could not successfully update network info during initialization.\n\n",
  "Locale": "en",
  "Image Attachments": [
    "https://d38gnqwzxziyyy.cloudfront.net/integrations/1122.png?Expires=4826692062&Signature=V-vBHr8GiVhC01KPn0FUd7DeGHIkNwLDVKsoB75Hf9rM64XamdmgT8acDnb7VjOtAYl7C37jzfYDnzFJrs1kTO8aahcIu889ICAlZJjwce3xGt-cmNZ1xHCazXR9Tw0I~Kql1e0Q8weSzNRX~vpxOK-XhLEpHDGOmsTgkaQ9bnlwiz4-6nM~~3QOa9FuLVjsWpLCV~2GqGCFzTmIikDSs1LjpHGif9Van1D9~QL5m9asqZTFihnLLBvcFXlc2LCxR3hXbpiprHpMIbwVlGRTzb8w1uEKsZdVAjvgMpCMX7RwCf3KbtCs0iKBhw8-btd8h016RsGxJtHG6VoT9lMFzA__&Key-Pair-Id=APKAIXAG65U6UUX7JAQQ"
  ],
  "Type": "bug",
  "URL": "https://dashboard.instabug.com/bugs/HnT_hQcJ",
  "Non Image Attachments": []
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Instabug 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: "Type"
• Key Value Contains: [bug]
• Map Incident With: null
• Incident Title From: "Title”
• This will use the issue title 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 "Console Log" key in the Incident Description From field, the incident description will be the value of the "Console Log" key. In the example JSON payload provided earlier, this would result in a description like "2017-01-30 21:45:23.674 assertion failed: 16D32 14C89: libxpc.dylib + 62677 [0339A402-6531-30E9-8BC2-589C463CD6D6]: 0x7d\n\n2017-01-30 21:45:53.631 Normal message received by listener connection. Ignoring.\n\n2017-01-30 21:45:53.631 Could not successfully update network info during initialization.\n\n2017-01-30 21:45:56.402 Normal message received by listener connection. Ignoring.\n\n2017-01-30 21:45:56.402 Could not successfully update network info during initialization.\n\n".
• Resolve Filter:
• The resolve filter is turned off because this incident will not auto-resolve.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

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

5. Testing and Validation

5.1 Triggering Alerts

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

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.
• Instabug Permissions: Confirm that the webhook in Instabug 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 Instabug 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 Instabug matches the expected structure.

8. Conclusion

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

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