Reference

Introduction

The reference is your key to a comprehensive understanding of the Screeb Javascript SDK.

✨ If this is your first look at the documentation, we recommend beginning with the Getting started guide.

$screeb methods

After injecting the Screeb Javascript SDK in your website, you will have access to a global $screeb object. $screeb methods are executed sequentially and return a Promise.

Use the following syntax: $screeb(method, argument1, argument2, ...).

Method	Definition	More
init	The init method starts the SDK and associates the current session to your Screeb project. Your website identifier must be passed. Optionally, this method can identify the current user. If no user identifier is provided, an anonymous visitor session is created. You will be able to later change the current user by using the identity method.	👉
close	The close method shutdowns the Screeb SDK. It is the opposite to init.	👉
debug	The debug method prints the current configuration of Screeb SDK, with website id, user id, session duration...	👉
identity	The identity method tells Screeb who the current user is. When Screeb is only installed on the logged page, please identify users using the init method instead. If your website has public pages, this method allows identifying users lazily, on user login.	👉
identity.properties	The identity.properties method associates some contextual properties to the current user session. You will be able to personalize surveys and target questions to the right audience.	👉
identity.group.assign	The identity.group.assign method assigns the current user to a Screeb segment. Some properties can be passed to the method to contextualize the segment.	👉
identity.group.unassign	The identity.group.unassign method unassigns the current user from a Screeb segment.	👉
identity.reset	The identity.reset method tells Screeb to reset the current user session and switch to an anonymous user. Please note it won't disable the Javascript SDK until you call the close command.	👉
identity.get	The identity.get method allows you to retrieve the current user identity.	👉
identity.anonymous_id	The identity.anonymous_id method tells Screeb which anonymous id your CDP already uses for the current visitor.	👉
event.track	The event.track method tracks actions performed by current users, along with properties describing the event.	👉
event.screen	The event.screen method reports a screen change to the targeting engine. Only available when the tag runs inside a Screeb-instrumented mobile webview.	👉
event.copilot	The event.copilot method tracks actions performed by users with AI copilots, along with properties describing the event.	👉
message.start	The message.start method starts a message by providing its id. Optionally, this command can prevent a user to see a single message multiple times. Please note that running a message using message.start will require a developer: to be autonomous, use the Screeb targeting engine instead.	👉
message.close	The message.close method interrupts a message.	👉
message.debug	The message.debug method prints the status of each active message and its associated targeting rules.	👉
survey.start	The survey.start method starts a survey by providing its id. Optionally, this command can prevent a user to see a single survey multiple times. Please note that running a survey using survey.start will require a developer: to be autonomous, use the Screeb targeting engine instead.	👉
survey.close	The survey.close method interrupts a survey.	👉
session-replay.start	The session-replay.start method starts session replay recording. Once started, user interactions will be captured for replay in the Screeb platform.	👉
session-replay.stop	The session-replay.stop method stops session replay recording.	👉
color-scheme.set	The color-scheme.set method forces the color scheme surveys and messages render in: "light", "dark" or "auto". It overrides the colorScheme init option; "auto" goes back to following your page.	👉
targeting.debug	The targeting.debug method prints the status of each targeting rule for each survey of your account.	👉

Dark mode

Surveys and messages draw your theme's dark values when they render in dark mode. A theme without dark values looks the same in both schemes.

By default ("auto"), the tag picks the scheme from, in order:

1. in a mobile app webview, the app's appearance;
2. a marker on your page's <html> element: a dark or light class, a data-theme, data-color-scheme, data-mode or data-bs-theme attribute set to dark or light, or a single color-scheme (dark or light, not light dark);
3. the visitor's device setting.

To decide yourself, pass the colorScheme option to init ("light", "dark" or "auto"):

$screeb("init", "<website-id>", { colorScheme: "dark" });

The option can also be set before the tag loads, via the window.ScreebConfig object:

window.ScreebConfig = { colorScheme: "dark" };

If your app has its own theme switch that sets none of these markers, call color-scheme.set from it with "dark" or "light". Running surveys and messages update right away:

$screeb("color-scheme.set", "light");

npm module

Screeb.setColorScheme comes to the npm modules (@screeb/sdk-browser and the framework packages) in a later release. Meanwhile, the $screeb("color-scheme.set", …) command works with any installation.

Privacy helpers

Privacy annotations are applied as plain HTML classes/attributes rather than $screeb calls. See Privacy helpers.