ReactNative SDK

πŸ”§ SDK

Initialize the SDK

Import the BugBattle SDK by adding the following import inside your index.js.

import BugBattle from 'react-native-bugbattle-sdk';

Add the initialization function within your index.js after AppRegistry.registerComponent(appName, () => App);.

BugBattle.initialize('YOUR_API_KEY', BugBattle.SHAKE);

Your API key can be found in the project settings within BugBattle. Possible values for the activation method are BugBattle.NONE and BugBattle.SHAKE.

BugBattle.NONE: No automatic activation.

BugBattle.SHAKE: Activation on device shake.

BugBattle.SCREENSHOT: Activation on screenshot gesture.

Multiple activation methods

It's also possible to initialize the SDK with multiple activation methods.

BugBattle.initializeMany('YOUR_API_KEY', [Bugbattle.SCREENSHOT, Bugbattle.SHAKE]);

Manually initiate the bug reporting flow

Some situations require more control about the activation of the bug reporting flow. By calling the startBugReporting method, you can simply start the flow manually. In order to also prevent the shake gesture, just initialize the Bugbattle SDK with the activation method BugBattle.NONE.


Customer email address

Sets the customer's email address.

BugBattle.setCustomerEmail("[email protected]")

Attach custom data

Sometimes you need to attach custom data to bug reports in order to solve them more quickly. Any simple dictionary can be attached.

BugBattle.attachCustomData({"aKey": "containsAwesomeData"})

πŸŽ₯ Replays

Bugbattle Replays offer session replays of the last 60 seconds prior to a bug report. This allows you to gain a better understanding of how a bug occurred. The great thing is that we don't require any further user permissions for the replays.


🌎 Network logging

Bugbattle allows you to monitor all network requests for a better understanding of what's happening within your web-apps & websites. The feature is currently in BETA. Please enable network logging by calling the following method right after initializing the SDK.

// Enables the network logger.

πŸ’¬ Language

Bugbattle automatically uses the system language (if a translation is available) as default SDK language. It's possible to force a language by adding the following method call.


Available translations: en, de, fr, it, es We are happy to add more languages based on your requests!

πŸ•΅οΈ Privacy policy

Enable privacy policy check

Enables the privacy policy check within the bug reporting flow. With this option set to true, users must accept the privacy policy in order to send a bug report.


Privacy policy url

Sets the privacy policy url. This is especially handy if you have any special requirements regarding the privacy policy. The default url is set to the Bugbattle privacy policy.


πŸ₯· Silent bug reports

Sometimes you know that something went wrong, but don't want to bother the user. In this case, you may want to send a silent bug report by calling the following method:

BugBattle.sendSilentBugReport('[email protected]', 'Awesome bug description.', 'LOW');

πŸ–₯ Self-Hosted

API url

Sets the API url to your internal Bugbattle server. Please make sure that the server is reachable within the network.