Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gleap.io/llms.txt

Use this file to discover all available pages before exploring further.

The Gleap SDK for Android is the easiest way to integrate Gleap into your apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites. For the SDK to work, you need an API key, which you can get for free at app.gleap.io.

​
🏗 Installation

Gleap is distributed through the maven. Add the following to you build.gradle (Module: app). 
implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '15.3.0'
The Gleap SDK is now almost successfully installed. Let’s carry on with the initialization 🎉

​
👷‍♂️ Initialize & configure the SDK

Open your preferred development tool and add the following code to your main activity (typically MainActivity.java). 
import io.gleap.Gleap;
These two includes are everything you need. 
@Override
protected void onCreate(Bundle savedInstanceState) {
    ....
    Gleap.initialize("YOUR_API_KEY", this);
}
You are all set now! Run the app and report your first bug 🎉.
Get your API key here.

​
Required permissions

In order to use the image picker for attachments, add the following permissions to your AndroidManifest.xml. 
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VISUAL_USER_SELECTED"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" />
The following permissions are needed to enable audio recordings. 
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-feature android:name="android.hardware.audio.pro" android:required="false" />
<uses-feature android:name="android.hardware.microphone" android:required="false" />
The following permissions are needed for our video call feature:

​
🤝 Need help?

We are here to help, simply drop us an email at hello@gleap.io.