Skip to main content
Version: Kotlin Multiplatform SDK

How Screeb works

The KMP SDK initializes Screeb with a channel id, then forwards user identity, properties, events, screens, groups, surveys, messages, hooks, and session replay controls to the native Android and iOS SDKs.

Most features are event-driven. After initialization, Screeb evaluates your workspace targeting rules and displays eligible surveys or messages inside the app.

Initialize Screeb once, as early as possible in your app lifecycle:

Screeb.initSdk(
    channelId = "<YOUR_CHANNEL_ID>",
    userId = "user_123",
    properties = mapOf("plan" to "pro"),
)

Then keep Screeb updated as your app state changes:

Screeb.trackScreen("Checkout")
Screeb.trackEvent("Plan Selected", mapOf("plan" to "team"))
Screeb.setProperties(mapOf("role" to "admin"))