Getting Started
Learn how to add the OpenWeb SDK to your Android app.
The Android SDK enables you to create a fluent conversation experience in your Android app that fuels quality interactions with community and content and allows users to create valuable and engaging content. Benefits of the Android SDK include:
- SSO support.
- Customizable Conversation appearance.
- New design preset options to seamlessly integrate the user experience with your brand's aesthetic
- Ability to continue a conversation started on your web pages

Prerequisites
Before you begin, make sure your environment meets the following requirements:
- Tool: Android Studio.
- Android Version: Minimum API Level 23 (Android 6.0) or higher.
- OpenWeb Account: Ensure you have access to your publisher-specific Spot ID.
Add the SDK Dependency
The OpenWeb SDK is distributed via Maven Central. Add the following dependencies to your app’s build.gradle
file:
plugins {
id 'com.android.application'
id 'kotlin-android'
}
dependencies {
...
implementation 'io.github.spotim:spotim-sdk:2.2.0'
}
Ensure Maven Central is listed in your settings.gradle
or build.gradle
file:
repositories {
mavenCentral()
maven { url "https://jitpack.io" }
}
As of version
2.2.0
, addingjitpack.io
to yourrepositories
block is no longer required.
In the AndroidManifest.xml
file, add the necessary permissions to use the internet and to allow users the ability to add images to comments from their camera or photo library:
<uses-feature android:name="android.hardware.camera" android:required="false" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<application>
...
</application>
Initialize the SDK
The SDK requires initialization with your unique Spot ID. Perform this initialization in your Application
class or the entry point of your app:
import com.openweb.sdk.OpenWeb
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
// Initialize the OpenWeb SDK
OpenWeb.manager.spotId = "YOUR_SPOT_ID"
}
}
Replace YOUR_SPOT_ID
with the Spot ID provided to you by OpenWeb.
Troubleshooting
- SDK Not Initialized: Make sure that
OpenWeb.manager.spotId
is set before accessing any SDK features. - Dependency Issues: Verify that Maven Central is included in your project repositories.
- Logging: Use the
OWLoggerConfiguration
utility to enable detailed logs during development.
For further assistance, contact OpenWeb support.
Updated 4 days ago