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

Disabling/Enabling Bug Reporting

This section covers how to disable and enable bug reporting.

When your users invoke the SDK, a popup appears with default Prompt Options for them to "Report a problem" (submit a bug, "Suggest an improvement" (send you feedback), or "Ask q question" (send you a chat).

These options can be disabled or enabled separately. When only a single option is enabled, it becomes the default invocation mode and the Prompt Options menu doesn't appear.

The example below disables bug reporting and feedback and makes In-App Chat the default invocation mode so that when users invoke Instabug, they are shown the conversations page directly.

// Disable the Bugs & Feedback. If disabled, both "Report a problem" & "Suggest an improvement" are removed from the Instabug's prompt, and manually showing the bug reporting or feedback doesn't have an effect.
BugReporting.enabled = false
// Disable the Bugs & Feedback. If disabled, both "Report a problem" & "Suggest an improvement" are removed from the Instabug's prompt, and manually showing the bug reporting or feedback doesn't have an effect.
IBGBugReporting.enabled = NO;

You can also specify whether to show one of the Report a Problem or Suggest an Improvement options, or both using this API:

// Specify which of the feedback or bug options appear in the prompt options
BugReporting.promptOptionsEnabledReportTypes = [.bug, .feedback]
// Specify which of the feedback or bug options appear in the prompt options
IBGBugReporting.promptOptionsEnabledReportTypes = IBGBugReportingReportTypeBug | IBGBugReportingReportTypeFeedback;

By default, all three options are enabled if they are available in your current plan.


What's Next

Give the Prompt Options page a look to see how you can further customize what your users can do with Instabug.

Prompt Options

Disabling/Enabling Bug Reporting


This section covers how to disable and enable bug reporting.

Suggested Edits are limited on API Reference Pages

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