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

Showing Instabug

This section covers how to set the user action that initializes Instabug, as well as how to customize what appears to your app users after the SDK is shown for Flutter apps.

By default, Instabug is shown when the device is shaken. This can be customized to several other modes that show the SDK. You can also invoke the SDK manually from a custom gesture or a button you add to your app.

Invocation Events

You can set the SDK to be invoked when your users do one or more of the following actions:

  • Shake device
  • Take a screenshot
  • Tap on a floating button shown above your app's UI
  • Two-finger swipe from right to left
  • None (manual showing)

You have the option to set one or multiple invocation events. To customize the invocation event, pass one of the values of the InvocationEvent enum when starting the SDK.

Instabug.start('APP_TOKEN', [InvocationEvent.shake]);

//Second argument takes an array of invocation events
ArrayList<String> invocationEvents = new ArrayList<>();
invocationEvents.add(InstabugFlutterPlugin.INVOCATION_EVENT_SHAKE);
new InstabugFlutterPlugin().start(CustomFlutterApplication.this, "APP_TOKEN", invocationEvents);

You can find the possible invocation events below.

InvocationEvent.none
InvocationEvent.shake
InvocationEvent.screenshot
InvocationEvent.twoFingersSwipe
InvocationEvent.floatingButton
InstabugFlutterPlugin.INVOCATION_EVENT_NONE
InstabugFlutterPlugin.INVOCATION_EVENT_SHAKE
InstabugFlutterPlugin.INVOCATION_EVENT_SCREENSHOT
InstabugFlutterPlugin.INVOCATION_EVENT_SWIPE
InstabugFlutterPlugin.INVOCATION_EVENT_BUTTON

Floating Button

If you are using the floating button, you can set its default position as explained here.

None

Use the "none" event if you want to invoke the SDK manually in order to prevent the SDK from being shown through the other events.

Changing the Invocation Event

If you want to change the invocation event to any of the other supported events, you can do so at runtime‚Äč as shown below.

BugReporting.setInvocationEvents(List<InvocationEvent> invocationEvents)

Manual Showing

If you want to show the SDK manually, use the show method.

Instabug.show();

Changing the Invocation Mode

By default, when the Instabug SDK is shown, a popup appears to your app users with options for them to report a bug ("Report a bug"), share feedback ("Suggest an improvement"), or ask you a question ("Ask a question").

The Prompt Options menu appears when Instabug is invoked in your app.

The Prompt Options menu appears when Instabug is invoked in your app.

Instead of showing this Prompt Options menu that lets your users choose what they want to do, you can skip this step and take users directly to the bug, feedback, or question reporting flow.

For bug, feedback, and questions, you can also specify invocation options as described here.

// Compose a new bug report
BugReporting.showWithOptions(BugReporting.reportType.bug, [BugReporting.option.emailFieldHidden]);
// Compose new feedback
BugReporting.showWithOptions(BugReporting.reportType.feedback, [BugReporting.option.emailFieldOptional]);
// Compose a new question
BugReporting.showWithOptions(BugReporting.reportType.question, [BugReporting.option.emailFieldOptional]);
// Show the previous chats list
Replies.show();

What's Next

Learn how to customize the welcome message to your users or maybe even report your first bug.

Welcome Message
Bug Reporting

Showing Instabug


This section covers how to set the user action that initializes Instabug, as well as how to customize what appears to your app users after the SDK is shown for Flutter apps.

Suggested Edits are limited on API Reference Pages

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