Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

Get Started

Bug Reporting

This page contains an overview of the of the content available in the bug reporting sections.

Integrating and Showing Instabug

To use the bug reporting feature of the Instabug SDK, integrating the SDK is required. You also need to be able to show the SDK.

Your users and beta testers can report bugs in every page in your app. These reports will reach you with all the information and logs you need to pinpoint those pesky bugs. More details can be found in the following sections:

1. Bug Report Content
This section details what you can expect with every bug report, such as logs and attachments, as well as how to require users to enter their emails or enter comments.

2. Reply to Bug Reporters
In this section, you can find instructions on how to reply to any given bug report in order to communicate with the reporter.

3. Extended Bug Report
Sometimes, additional details are required in the bug reports to help you pin down the bugs. Your QA team and internal testers will also want more fields to fill when reporting a bug. This is where Extended Bug Reports come into play to add fields like Steps to Reproduce, Actual Results and Expected Results.

4. Event Handlers
If you wish to have any blocks of code run before or after a report is sent, this section details just how you can do that.

5. Disabling/Enabling Bug Reporting
Instabug has many different features. If you only use other features instead of the bug reporting, you can disable the bug reporting by following the instructions in this section.

Bug Reporting


This page contains an overview of the of the content available in the bug reporting sections.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.