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. Tell Screeb which anonymous id your CDP uses​

Before login, CDP events carry only the CDP's own anonymous id (Amplitude device id, Segment and RudderStack anonymous id). Give that id to Screeb with Screeb.setAnonymousId: the current respondent adopts it and stays anonymous. When the CDP integration already created a respondent for that id, Screeb switches to it, so the events it already received are not lost. An identified respondent is never switched away from: the id then stays with its owner. If Screeb switches, any survey running for the previous respondent closes, as with resetIdentity.

Screeb.setAnonymousId(cdpAnonymousId) // e.g. Amplitude's device id

Call it right after initSdk: the call is queued and resolved during init, before any respondent is created, so the two calls behave like a single init option. Calling it later works too.

The id must be 5 to 128 characters. Calling it again with the same id does nothing. Nothing changes in your CDP installation: Screeb never writes to it, and other tools wired to your CDP are not affected.

Do not pass the CDP anonymous id to setIdentity: that turns it into a user identity, and the real login then creates a second respondent instead of merging.

If you cannot read the CDP anonymous id in the app, the reverse also works: read the Screeb anonymous id with Screeb.getIdentity and give it to your CDP as its device or anonymous id before the CDP sends its first event. Prefer the recipe above: changing your CDP's device id also changes it for every other tool connected to that CDP.

3. Reset both tools together on logout​

Reset Screeb, reset your CDP, then give Screeb the CDP's new anonymous id. Reset once, on logout only: resetting on every anonymous screen creates a new respondent each time on both sides.

Each reset starts a new anonymous id, and a respondent holds at most 20 ids: past that, a new anonymous id is no longer attached to it, and later CDP events carrying only that id create an anonymous respondent.

Screeb.resetIdentity()
// reset your CDP, then read its new anonymous id
Screeb.setAnonymousId(cdpAnonymousId)

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: the workspace setting also refuses the adoption on an anonymous respondent (anonymous_user_not_allowed). 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 lists the CDP anonymous id among its aliases, then the user id after login, and a survey targeted on a CDP event displays a few seconds after the event.