Skip to content
Open Screeb

Start a message programmatically

Start an in-app message from your code, with hidden fields and a forced language, then close it when you need to.

Most messages start on their own, when the Screeb targeting engine finds a match. Start a message from your code when the trigger is something only your app knows, such as the first visit to a new feature.

The message id is in the message editor URL, after /messages/. To keep the message from also starting on its own, set its trigger to manual in the admin: see Message targeting.

import { Component } from "@angular/core";
import { Screeb } from "@screeb/sdk-angular";
@Component({
selector: "app-whats-new-button",
template: `<button (click)="showWhatsNew()">What's new</button>`,
})
export class WhatsNewButtonComponent {
constructor(private screeb: Screeb) {}
async showWhatsNew() {
await this.screeb.messageStart("<MESSAGE-ID>");
}
}

By default, a message started from your code shows again even if the user already saw it. Turn off multiple responses to show it only once per user.

await this.screeb.messageStart("<MESSAGE-ID>", false);

Hidden fields attach values to the response. They show next to the response in the Screeb admin and in exports, so you know where the message started.

await this.screeb.messageStart("<MESSAGE-ID>", true, {
source: "onboarding",
plan: "pro",
});

Pass an ISO 639-1 code, such as "en" or "fr", to show the message in that language. The language used is the first one set among: this parameter, the language passed at initialization, the user’s language property, then the browser or device language.

await this.screeb.messageStart("<MESSAGE-ID>", true, {}, undefined, "en");

Pass hooks when you start the message to run your code when it shows, gets a click or closes. See Hooks for the list and the payloads.

Close the messages on screen, for example when the user leaves the page the message is about.

// Closes every running message
await this.screeb.messageClose();