Skip to main content
Version: Browser SDK

Start survey programmatically

In most cases, let the Screeb targeting engine start surveys. Use this method for custom triggers such as a feedback button.

tip

You can find the SURVEY_ID in the Manual section of the survey editor, or in the survey editor URL after /surveys/.

import * as Screeb from "@screeb/sdk-browser";

Screeb.surveyStart("<SURVEY_ID>");

Prevent multiple displays​

Screeb.surveyStart("<SURVEY_ID>", undefined, false);

Hidden fields (contextualize response)​

Screeb.surveyStart("<SURVEY_ID>", undefined, true, {
  color: "green",
  article_id: 42,
});

Force language​

Screeb.surveyStart("<SURVEY_ID>", undefined, true, {}, undefined, "en");

Target a specific element​

Screeb.surveyStart("<SURVEY_ID>", undefined, true, {}, undefined, undefined, ".my-element");

Close a survey​

Screeb.surveyClose(); // closes all running surveys