Android SDK

Show Zigpoll surveys inside your Android app. The SDK presents surveys in a native bottom sheet — you decide exactly when a survey appears by triggering it from code.

Prefer to start from working code? Clone the ready-to-run example app. SDK source: zigpoll-android.

Requirements

• Android 7.0 (API 24) or later

• Kotlin or Java

Installation

The SDK is distributed via JitPack. Add the repository in settings.gradle:

dependencyResolutionManagement {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Then add the dependency in your module's build.gradle:

dependencies {
    implementation 'com.github.zigpoll:zigpoll-android:master-SNAPSHOT'
}

Set up your survey

1. In the Zigpoll dashboard, create a survey.

2. Set the survey's delivery type to API (Delivery Settings → API).

3. Copy the survey ID from the survey's install section.

Configure the SDK

In your Application subclass:

import com.zigpoll.Zigpoll

Zigpoll.configure(context, "YOUR_ACCOUNT_ID")

Identify the user (recommended)

Zigpoll.identify("user_123", mapOf(
    "email" to "[e-mail]",
    "name" to "Jane"
))

Call Zigpoll.logout() when the user signs out.

Trigger a survey

Zigpoll.trigger("SURVEY_ID", activity)

The survey appears in a bottom sheet. Responses are recorded slide by slide, so partial responses are captured even if the user dismisses the sheet mid-survey.

Metadata

Zigpoll.setMetadata(mapOf("plan" to "pro"))

The SDK automatically includes source=mobile-sdk, platform=android, the SDK version, and your app version.

Callbacks

Zigpoll.onComplete = { responses -> }
Zigpoll.onClose = { responses -> }
Zigpoll.onError = { error -> }

Development builds

Zigpoll.configure(context, "YOUR_ACCOUNT_ID", preview = true)

With preview = true, surveys open and behave normally but responses are not billed or counted in your analytics.