HomeDocumentationAPI Reference
Getting StartedAPI ReferenceHelp CenterVideo Tours

Integrating Instabug

This page covers how to install the Instabug SDK in your React Native application.

🚧

Expo Support

Please note that we don't currently support the managed workflow of Expo.

Installation

If you are upgrading from versions prior to v11.0, check our Migration Guide.

  1. Open the command line and navigate to your React Native Directory. Then, run the following command.
npm install instabug-reactnative

If you prefer using Yarn, you can use the following command instead.

yarn add instabug-reactnative
  1. CocoaPods on iOS needs this extra step:
cd ios && pod install && cd ..

Using Instabug

To start using Instabug, import and initialize the SDK as follows in your index.js file. This line will let the Instabug SDK work with the default behavior. The SDK will be shown when the device is shaken. You can customize this behavior through APIs.

import Instabug, { BugReporting, Surveys, FeatureRequests } from 'instabug-reactnative';
Instabug.start('APP_TOKEN', [Instabug.invocationEvent.shake]);

You can find your app token by selecting SDK Integration in the Settings menu from your Instabug dashboard.

Same Build for Beta and App Store

The following method handles both cases: when your app is running live from the App Store and if it is running from your simulator, Xcode, Fabric Beta, or Test Flight.

Instabug.isRunningLive(function (isLive) {
  if (isLive) {
    Instabug.start('LIVE_TOKEN', [Instabug.invocationEvent.none]);
  } else {
    Instabug.start('BETA_TOKEN', [Instabug.invocationEvent.screenshot]);
  }
});

Managing Permissions

Instabug needs access to the device microphone and photo library to be able to let users add audio, image, and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those two permissions will be rejected when submitted to the App Store.

To prevent your app from being rejected, you’ll need to add the following two keys to your app’s info.plist file with text that explains to your app users why those permissions are needed:

  • NSMicrophoneUsageDescription
  • NSPhotoLibraryUsageDescription

If your app doesn’t already access the microphone or photo library, we recommend usage descriptions like:

  • " needs access to your microphone so you can attach voice notes."
  • " needs access to your photo library so you can attach images."

The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.

🚧

Permissions Are Required

The above permissions are required in order for you to receive attachments from your users through the Instabug SDK.


What’s Next

Now that you've successfully integrated Instabug, check out how to show Instabug using different methods, how to identify your users, or how to customize your SDK.