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

Prompt Options

This section covers how to control the popup menu that appears when your app users show Instabug.

By default, when your app users invoke Instabug, a popup appears that asks them "How can we help you?" with menu options to report a bug, share feedback, or send you a message, depending on the products enabled in your plan. This popup is called Prompt Options.

All Instabug popups follow the color theme and primary color that you set for the SDK.

An example of the Prompt Options menu that appears to app users after Instabug is shown.

An example of the Prompt Options menu that appears to app users after Instabug is shown.

By default, all of your enabled products are listed in the Prompt Options menu. You can control which options appear by disabling and enabling any of the products. Each one can be enabled or disabled separately.

// 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.
cordova.plugins.bugReporting.setEnabled(boolean, successCb, errorCb)

// Specify which of the feedback or bug options appear in the prompt options
cordova.plugins.bugReporting.setReportTypes([cordova.plugins.bugReporting.reportType.bug, cordova.plugins.bugReporting.reportType.feedback], successCb, errorCb)

// Disable the Chats. If disabled, The "Ask a question" (this is the new content instead of "Talk to us") option is removed from Instabug's prompt, the compose button in the chats list is removed, and manually showing the chats compose view of the chats doesn't have an effect.
cordova.plugins.chats.setEnabled(boolean, successCb, errorCb)

// Disable the Replies. If disabled, the chats list button is removed from Instabug's prompt, the in-app notifications are disabled, and manually showing the chats list doesn't have an effect. 
cordova.plugins.replies.setEnabled(boolean, successCb, errorCb)

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


What's Next

Your Prompt Options are now set and ready for action, so let's teach your users how to access this menu.

Welcome Message

Prompt Options


This section covers how to control the popup menu that appears when your app users show Instabug.

Suggested Edits are limited on API Reference Pages

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