Instabug

Getting Started
API Reference

Help Center
Video Tours

Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

v7.0deprecated
v8.0deprecated
v8.1deprecated
(Privacy Updates)
v8.2
(Surveys and Announcements)
v8.3
(Surveys and Announcements)
v8.5
(New Repro Steps)
v8.6
(Bugs + Chats Merge)
v9.0
(Nested Report Categories)
v9.1
(Insights)
v9.1.5stable
(Android Repro Steps Fix)

HomeDocumentationAPI ReferenceReferenceHelp CenterDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Getting Started

Introduction
Helpful Resources

iOS

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

Android

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

React Native

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

Flutter

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
- Showing the Feature Requests List
- Feature Request Content
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations

Cordova

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations
SDK 8.6 Migration Guide

Xamarin

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations
SDK 8.6 Migration Guide

Unity

Overview
iOS Integration
Android Integration
Invoking Instabug
Bug Reporting
Reports Data
- Identify User
- Attachments

Web - Open Source

Open Source Web SDK 1.0
Recommended Tools

Other

Integrations
GDPR
SDK Size
Premium Plan
Keyboard Shortcuts

Getting Started

Introduction
Helpful Resources

iOS

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

Android

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

React Native

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
SDK Customizations
SDK 8.6 Migration Guide

Flutter

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
Crash Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
- Showing the Feature Requests List
- Feature Request Content
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations

Cordova

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations
SDK 8.6 Migration Guide

Xamarin

Overview
Integrating Instabug
Showing Instabug
Bug Reporting
In-App Replies
Surveys & Announcements
In-App Feature Requests
User Identification/Data
- User Identification
- Setting Custom Data
Logs & Profiling
- Session Profiler
- Report Logs
SDK Customizations
SDK 8.6 Migration Guide

Unity

Overview
iOS Integration
Android Integration
Invoking Instabug
Bug Reporting
Reports Data
- Identify User
- Attachments

Web - Open Source

Open Source Web SDK 1.0
Recommended Tools

Other

Integrations
GDPR
SDK Size
Premium Plan
Keyboard Shortcuts

Invocation

Building Instabug
Displaying Instabug
- Show Prompt Options
- Show Specific Mode
Change Invocation Event
Set Shaking Threshold
Set Prompt Options (Disabling Features)

Bug Reporting

Email and Comment Requirement (Options)
Extended Bug Report Mode
Set Private View
Take Screenshot by Media Projection

Crash Reporting

Enable or Disable Crash Reporting
Report Exception
Report Error

In-App Replies

Show Replies List
Push Notifications
In-App Notifications
- Managing Sounds
- Enable or Disable In-App Notifications
Check for Existing Chats
Get Unread Count
Enable or Disable Replies

User Identification/Data

Identify User
User Attributes
User Data
Log Out

Report Data

Logging
Repro Steps
Attachments
Tags
Session Profiler

In-App Surveys

Manually Show Survey
Check if Responded
Get Available Surveys
Show Available Survey
Show Survey Welcome Message
Enable or Disable Auto-Showing
Enable or Disable Surveys

In-App Feature Requests

Show Feature Requests
Setting Email Requirement

User Interface/Design

Set Theme
Set Primary Color
Set Floating Button Position
Set Video Recording Button Position
Manipulating the Welcome Message
- Manually Show Welcome Message
- Set Welcome Message Mode
Set Locale
Change String Values

SDK Event Handlers

Set Pre-Invocation Handler
Set Pre-Sending Handler
Set Did-Dismiss Handler
Set Received-Reply Handler
Set Will-Show-Survey Handler
Set Dismissed-Survey Handler

Getting Started

Introduction
Helpful Resources

iOS

Overview
Integrating Instabug
Showing Instabug

Android

Overview
Integrating Instabug
Showing Instabug

React Native

Overview
Integrating Instabug
Showing Instabug

Flutter

Overview
Integrating Instabug
Showing Instabug

Cordova

Overview
Integrating Instabug
Showing Instabug

Xamarin

Overview
Integrating Instabug
Showing Instabug

Unity

Overview
iOS Integration
Android Integration

Web - Open Source

Open Source Web SDK 1.0
Recommended Tools

Other

Integrations
GDPR
SDK Size