Closed Test SDK

Terminology

Initialization (auto-init, recommended)

The SDK starts via AndroidX App Startup when the dependency is on the classpath.

AndroidManifest.xml

<application ...>
    <!-- Optional: Advanced ingest. Omit for Base when keyless ingest is enabled on the test card. -->
    <meta-data
        android:name="io.closedtest.sdk.publishable_key"
        android:value="pk_live_YOUR_KEY_HERE" />
</application>

• Backend URL is not configured in app code — it is embedded in the SDK.
• Missing or empty publishable_key → Base handshake (when enabled on the test card).
• Non-empty key → Advanced handshake.
• ClosedTest.initialize(...) remains available; duplicate calls are ignored.

Disable auto-init (optional)

<meta-data
    android:name="io.closedtest.sdk.auto_init_enabled"
    android:value="false" />

Then call ClosedTest.initialize from Application.onCreate or your entry Activity.

Keep the publishable key out of git

Do not commit pk_live_… in AndroidManifest.xml. Inject at build time.

Gradle property (local)

In ~/.gradle/gradle.properties (user-wide, not in the repo) or a gitignored project gradle.properties:

closedTest.publishableKey=pk_live_YOUR_KEY_HERE

project.findProperty("closedTest.publishableKey") reads this. local.properties is not merged into findProperty automatically — load it explicitly in build.gradle.kts if you store the key only there.

build.gradle.kts

android {
    defaultConfig {
        val pk = (project.findProperty("closedTest.publishableKey") as String?)
            ?: System.getenv("CLOSED_TEST_PUBLISHABLE_KEY")
            ?: ""
        manifestPlaceholders["closedTestPublishableKey"] = pk
    }
}

<meta-data
    android:name="io.closedtest.sdk.publishable_key"
    android:value="${closedTestPublishableKey}" />

CI

Set secret CLOSED_TEST_PUBLISHABLE_KEY in GitHub Actions or your CI — never commit the key. See examples/sample in the SDK repo for a working sample.

Manual initialization

ClosedTest.initialize(
    context = applicationContext,
    publishableKey = "pk_live_YOUR_KEY_HERE",
    options = ClosedTestOptions(/* see below */),
)

If auto-init already ran with the same key, a later call is a no-op.

ClosedTestOptions

Manifest meta-data for auto-init (optional):

<meta-data android:name="io.closedtest.sdk.daily_reminder_enabled" android:value="false" />
<meta-data android:name="io.closedtest.sdk.daily_reminder_hour" android:value="18" />
<meta-data android:name="io.closedtest.sdk.daily_reminder_minute" android:value="30" />

Disable the organizer-app hint via manifest:

<meta-data
    android:name="io.closedtest.sdk.proofflow_hint_enabled"
    android:value="false" />

Manual events

ClosedTest.trackScreen("Home")
ClosedTest.trackInteraction("tap")
ClosedTest.trackEvent("onboarding_done", mapOf("step" to "2"))
ClosedTest.flush() // force upload

For navigation funnels and automatic Compose tracking, see the screen flow guide (screen_view events).

Tester binding

Link a tester session when your flow provides IDs (e.g. from Dozenflow):

ClosedTest.handleDeepLink(intent?.data)

// or
ClosedTest.bindTester(
    testerId = "…",
    testSessionId = "…",
)

Organizer app hint dialog

When POST /v1/init returns proofflow_test_id and hints are enabled, the SDK may show a dialog to open the Dozenflow organizer app:

proofflow://test/{proofflow_test_id}

Testers can dismiss, snooze, or opt out permanently. Your app is not blocked if the organizer app is not installed.

Local daily test reminder (not FCM)

The SDK can show a local notification on the tester’s device — no Firebase in anyapp, no remote push from Dozenflow. This complements (does not replace) Remind participants in the Dozenflow organizer app, which uses FCM to the Dozenflow APK.

• Default time: 15:00 in the device’s local timezone.
• Condition: the app was not brought to the foreground yet today (calendar day, local).
• Tap: opens your app’s launcher activity.
• Configure: ClosedTestOptions or manifest io.closedtest.sdk.daily_reminder_* meta-data.

ClosedTest.initialize(
    context = applicationContext,
    publishableKey = publishableKey,
    options = ClosedTestOptions(
        dailyReminderEnabled = true,
        dailyReminderHourLocal = 15,
        dailyReminderMinuteLocal = 0,
    ),
)

Android 13+: add POST_NOTIFICATIONS to your app manifest and request runtime permission — otherwise the SDK skips the notification. Some OEMs may delay alarms under battery optimization.

Discovery marker (organizer app can detect the SDK)

The SDK merges an exported ContentProvider so the Dozenflow organizer app can verify a specific package has this SDK installed.

Disable:

<meta-data
    android:name="io.closedtest.sdk.discovery_enabled"
    android:value="false" />

Implicit discovery intent (optional): action io.closedtest.sdk.DISCOVERY (ClosedTest.DISCOVERY_INTENT_ACTION). On Android 11+, clients need <queries> for the intent. For a known package, prefer ContentProvider verification over intent-only checks.

What runs automatically

• Lifecycle: session_start, session_end, app_foreground, app_background
• Foreground heartbeat
• Room queue + batched upload
• Token refresh on HTTP 401
• Optional local daily reminder alarm (if enabled)

Organizer workflow

1. Create a test in the Dozenflow mobile app (package name, quotas, policy).
2. Copy publishable_key from Dozenflow or this site’s dashboard (when signed in).
3. Add the SDK to anyapp with that key (or use Base when keyless ingest is enabled on the test card).
4. Distribute your test build; testers use anyapp only.
5. Monitor progress in the Dozenflow app or the dashboard on this site.

Troubleshooting

Further reference

This page documents the organizer-facing integration path. Ingest contract and server policy are defined in the closed-test-sdk repository.