Skip to main content
Version: Angular SDK

Identity

Set identity​

Identify users on login so you can track them across sessions and match survey responses to real users.

Requirements:

  • The unique visitor id must be between 1 and 255 characters.

On module init​

ScreebModule.forRoot({
  autoInit: true,
  websiteId: "<YOUR-CHANNEL-ID>",
  userId: "<USER-ID>",
  userProperties: {
    firstname: "<user-firstname>",
    plan: "<user-plan>",
    last_seen_at: new Date(),
    authenticated: true,
  },
})

After init​

import { Screeb } from "@screeb/sdk-angular";

constructor(private screeb: Screeb) {}

// Set identity
await this.screeb.identity("<USER-ID>");

// With properties
await this.screeb.identity("<USER-ID>", {
  email: "support@screeb.app",
  plan: "growth-monthly",
});

Reset identity (logout)​

await this.screeb.identityReset();

Update properties​

await this.screeb.identityProperties({
  email: "support@screeb.app",
  age: 42,
  logged: true,
  signed_up_at: new Date(),
});

// Delete a property by setting it to null
await this.screeb.identityProperties({ company: null });

Get current identity​

const identity = await this.screeb.identityGet();

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.

await this.screeb.identity(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 anonymousId). Give that id to Screeb: the current respondent adopts it, and stays anonymous. When the CDP webhook 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 that switches the respondent, any survey it has running closes, as with identityReset(). Load order does not matter (call setAnonymousId after init).

const deviceId = amplitude.getDeviceId();
if (deviceId) await this.screeb.setAnonymousId(deviceId);

Call it as soon as the service is ready, right after init resolves (or from a component when you use autoInit). Screeb adopts the id on the respondent, or switches to the respondent your CDP webhook already created for it.

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 identity: 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 client side, the reverse also works: give your CDP the Screeb anonymous id (identityGet → amplitude.setDeviceId / setAnonymousId) 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.

await this.screeb.identityReset();
amplitude.reset();
const deviceId = amplitude.getDeviceId();
if (deviceId) await this.screeb.setAnonymousId(deviceId);

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: the workspace setting refuses setAnonymousId with 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 while the respondent is still marked anonymous, and a survey targeted on a CDP event displays a few seconds after the event.