Skip to main content
Version: Kotlin Multiplatform SDK

Identify users

Use identity methods to associate the current app session with a known user and update visitor properties used for targeting and analysis.

Identify a user​

Screeb.setIdentity(
    userId = "user_123",
    properties = mapOf(
        "email" to "dev@screeb.app",
        "plan" to "pro",
        "company" to "Screeb",
    ),
)

You can also pass the identity during initialization:

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

Update visitor properties​

Screeb.setProperties(
    mapOf(
        "role" to "admin",
        "trial" to false,
    ),
)

Reset identity​

Call resetIdentity when a user logs out.

Screeb.resetIdentity()

Read current identity​

val identity = Screeb.getIdentity()

Good practices with an existing CDP​

When Amplitude, Segment or RudderStack is a Screeb source, Screeb resolves the respondent of each forwarded event from its user id, or from its anonymous id when the visitor is not logged in. Once both ids appear on the same event, Screeb aliases them to one respondent, so a visitor who logs in keeps a single profile. Screeb never moves an id from one respondent to another, and it does not read your CDP's identifiers from your app: keeping the two tools on the same identifiers is part of your instrumentation. Three rules do it.

1. One user id, the same string everywhere​

Identify the user in Screeb with exactly the value you give your CDP's identify: a stable internal id rather than an email, which can change. Do it in the same place in your code so neither tool lags behind the other.

Screeb.setIdentity(userId)

Amplitude drops user ids and device ids shorter than 5 characters, and the event then reaches Screeb as anonymous: use ids of 5 characters or more.

2. Give your CDP the Screeb anonymous id​

Before login, CDP events carry only the CDP's own anonymous id, which is not the Screeb respondent the SDK displays surveys for. Read the Screeb anonymous id and hand it to your CDP as its anonymous or device id; the Screeb respondent id is one of its own aliases, so nothing else is needed on the Screeb side.

val anonymousId = Screeb.getIdentity()?.get("anonymous_id") as? String
// give anonymousId to your CDP, e.g. amplitude.setDeviceId(anonymousId)

Do this before the CDP sends its first event, using the device or anonymous id setter of your CDP's mobile SDK (setDeviceId for Amplitude; see your CDP's documentation for Segment and RudderStack). Server-side events must carry the same ids, forwarded from the app.

Without this rule, anonymous visitors exist twice (one respondent per tool) and surveys triggered by CDP events cannot display for them.

3. Reset both tools together on logout​

Reset Screeb, read the new anonymous id, then reset your CDP and give it that id, in this order. Reset once, on logout only: resetting on every anonymous screen creates a new respondent each time on both sides.

Screeb.resetIdentity()

Then repeat rule 2 with your CDP's reset.

What the "ignore anonymous users" settings change​

The integration's "ignore events from anonymous users" option and the workspace-level "Ignore anonymous users" setting drop CDP events that carry no user id. Rule 2 needs both off to cover the pre-login window. An event carrying a user id is never dropped by them, so the login-time merge happens either way.

Check it works​

Read the current identity and compare anonymous_id and user_id with what your CDP reports for the same visitor. In Screeb, the respondent page then lists both ids among its aliases, and a survey targeted on a CDP event displays a few seconds after the event.