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 change the event done by the user to show the SDK, as well as the default feature to be used once the SDK is shown.

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

Invocation Events

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

  • Shake device
  • Take a screenshot (using home + lock buttons)
  • Tap on a floating button shown above your app's UI
  • Swipe with two fingers from right to left
  • None (manual showing)
How to show Instabug

How to show Instabug

To customize the invocation event, pass one of the values of the Instabug.invocationEvent enum when starting the SDK.

//iOS
IBGBugReporting.InvocationEvents = IBGInvocationEvent.FloatingButton | IBGInvocationEvent.Screenshot;

//Android 
new Instabug.Builder(this, "ANDROID_APP_TOKEN")
            .SetInvocationEvent(InstabugInvocationEvent.FloatingButton, InstabugInvocationEvent.Shake)
						.Build();

You can find the possible invocation events below. The None event can be used in case you want to prevent the SDK from being shown by the normal way and show it later on manually whenever you need or under certain conditions.

//iOS
IBGInvocationEvent.None
IBGInvocationEvent.Shake
IBGInvocationEvent.Screenshot
IBGInvocationEvent.TwoFingersSwipeLeft
IBGInvocationEvent.RightEdgePan
IBGInvocationEvent.FloatingButton

//Android 
InstabugInvocationEvent.Shake
InstabugInvocationEvent.Screenshot
InstabugInvocationEvent.FloatingButton
InstabugInvocationEvent.ScreenshotGesture
InstabugInvocationEvent.TwoFingerSwipeLeft
InstabugInvocationEvent.None

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

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.

//iOS Only
IBGBugReporting.InvocationEvents = IBGInvocationEvent.FloatingButton;

Manual Showing

You can also show the event manually as follows.

Instabug.Show();

Recommendation

When you limit invoking Instabug to a specific screen (help or settings for example), the current screen that the SDK captures won't necessarily be relevant to the issue. To help you gain more context, it is recommended that you set up a list of custom categories that match the main features or views in your app and let the user choose one of them. You can find more details here.

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").

Instead of showing the 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
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Bug, IBGBugReportingOption.EmailFieldHidden);
// Compose a new feedback
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Feedback, IBGBugReportingOption.EmailFieldHidden);
// Compose a new question
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Question, IBGBugReportingOption.EmailFieldHidden);
// Show the previous chats list
IBGReplies.Show();
// Compose a new bug report
BugReporting.Show(BugReporting.ReportType.Bug, Option.EmailFieldHidden);
// Compose a new feedback
BugReporting.Show(BugReporting.ReportType.Feedback, Option.EmailFieldHidden);
// Show the previous chats list
Replies.Show();

Below are also all the possible options.

//Hide email
IBGBugReportingOption.EmailFieldHidden
//Show email as optional
IBGBugReportingOption.EmailFieldOptional
//Make comment required
IBGBugReportingOption.CommentFieldRequired
//Hide email
Option.EmailFieldHidden
//Show email as optional
Option.EmailFieldOptional
//Make comment required
Option.CommentFieldRequired

Shaking Threshold

If you are using the shaking gesture as your invocation event you can set how sensitive your device is to the shaking. The values in the following iOS example are the default ones. In the case of Android, the default value depends on the device used. The higher the value the less sensitive the device will be to shaking.

//iOS
IBGBugReporting.ShakingThresholdForiPhone = 3.0;
IBGBugReporting.ShakingThresholdForiPad = 1.0;

//Android
BugReporting.SetShakingThreshold(800);

What's Next

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

Welcome Message
Bug Reporting

Showing Instabug


This section covers how to change the event done by the user to show the SDK, as well as the default feature to be used once the SDK is shown.

Suggested Edits are limited on API Reference Pages

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