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

User Identification

This section covers how to bind each report to the identity of the user reporting the problem. You have the flexibility to add some extra attributes about the device as well as the user.

Instabug helps you better identify the bug reports or feedback you get by associating a user's identity to them.

User Email and Name

If you already have a user's name and email, you can pre-fill the email field in the bug, feedback, and question reporting flow. The user will then be identified in all reports (bugs, improvements, questions), crashes, surveys, and feature requests.

An example of a pre-filled email field in the bug reporting form.

An example of a pre-filled email field in the bug reporting form.

Ideally, this API should be called as soon as a user logs into your app.

Instabug.identifyUserWithEmail("john.appleseed@apple.com", "John Appleseed");

User Data

You can also add additional data about your users. This API is best used for dumping large amounts of data. Each call to this method overrides the user data to be attached. The maximum length of the string is 1,000 characters.

Instabug.setUserData("User data sample");

Logout

When a user logs out, the following API should be called. Calling logOut will reset the value of the email and name previously set. It will also remove any currently set user attributes, user events, user chats, and user data.

Instabug.logOut();

What's Next

With your users identified, they no longer need to input their email and name when reporting bugs or submitting feature requests and you'll know the name of users chatting with you. Learn more about each product below.

Bug Reporting
In-App Chat
In-App Feature Requests

User Identification


This section covers how to bind each report to the identity of the user reporting the problem. You have the flexibility to add some extra attributes about the device as well as the user.

Suggested Edits are limited on API Reference Pages

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