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 shows Instabug, as well as how to customize what appears to your app users after the SDK is shown for iOS apps.

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 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
  • Pan to the left from the right edge of the screen (one-finger swipe left)
  • Swipe with two fingers from right to left
  • None (manual showing)

Screenshot Gesture Recommendation

We recommend using the screenshot gesture to show Instabug only in your internal and beta builds. The screenshot gesture is already utilized by the OS to show the edit view of the captured screenshot. Hence, while using Instabug in your live app on the App Store, we recommend using the other gestures: shake, pan, two fingers swipe or manually through the app's UI.

How to show Instabug

How to show Instabug

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

Instabug.start(withToken: "YOUR-TOKEN-HERE", invocationEvents: [.shake, .screenshot])
[Instabug startWithToken:@"YOUR-TOKEN-HERE" invocationEvents: IBGInvocationEventShake | IBGInvocationEventScreenshot];

The possible invocation events are below.

.none
.shake
.screenshot
.twoFingersSwipeLeft
.rightEdgePan
.floatingButton
IBGInvocationEventNone
IBGInvocationEventShake
IBGInvocationEventScreenshot
IBGInvocationEventTwoFingersSwipeLeft
IBGInvocationEventRightEdgePan
IBGInvocationEventFloatingButton

None

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

Recommendation

If you set the event to "none" and you're showing Instabug manually from your app's UI, we recommend that you set up custom categories. Typically, while using the other gestures, the user can invoke Instabug from any screen in the app once they spot an issue which allows the SDK to capture the current screen and attach it to the report. However, 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. The recommended alternative is 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.

Floating Button

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

Shaking Threshold

If you are using the shaking gesture as your invocation event, you can set how sensitive the device should be to the shaking. The thresholds in the example below are the default values. The higher the value, the less sensitive the device will be to shaking.

BugReporting.shakingThresholdForiPhone = 3.0
BugReporting.shakingThresholdForiPad = 1.0
IBGBugReporting.shakingThresholdForiPhone = 3.0;
IBGBugReporting.shakingThresholdForiPad = 1.0;

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.invocationEvents = [.shake, .screenshot]
[IBGBugReporting setInvocationEvents:IBGInvocationEventShake | IBGInvocationEventScreenshot];

Manual Showing

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

Instabug.show()
[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").

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

The Prompt Options menu appears when Instabug is shown 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.show(with: .bug, options: [])
// Compose a new feedback
BugReporting.show(with: .feedback, options: [])
// Compose a new question
BugReporting.show(with: .question, options: [])
// Show the perevious chats list only if the the user already have a chats history. Calling this API won't have an effect otherwise.
Replies.show()

// Compose a new bug report
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeBug options:0];
// Compose a new feedback
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeFeedback options:0];
// Compose a new question
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeQuestion options:0];
// Show the perevious chats list only if the the user already have a chats history. Calling this API won't have an effect otherwise.
[IBGReplies 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 shows Instabug, as well as how to customize what appears to your app users after the SDK is shown for iOS apps.

Suggested Edits are limited on API Reference Pages

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