javascript api

Popup Messages

Show contextual popups with optional star ratings and feedback

The createPopup method displays a popup message above the chat launcher — for announcements, satisfaction surveys, or feedback collection.

Basic Usage

// Simple announcement
UserBoost.createPopup({
  message: { en: "Need help? We're here!", da: "Brug for hjælp? Vi er her!" }
});

With Star Rating

UserBoost.createPopup({
  message: { en: "How was your experience?" },
  rating: true,
  tag: "post-checkout"
});

With Rating + Feedback Text

UserBoost.createPopup({
  message: { en: "How was your shopping experience today?" },
  rating: true,
  feedbackText: true,
  tag: "satisfaction-survey"
});

Parameters

createPopup(config)Method

Parameter	Type	Required	Description
message	Record<string, string>	Required	Per-locale popup message text. The widget shows the message matching the visitor's language.
rating	boolean	Optional	Show a 5-star rating. Default: `false`.
feedbackText	boolean	Optional	Show a text input for detailed feedback (only works if `rating` is `true`). Default: `false`.
tag	string	Optional	Free-text label for grouping ratings in the dashboard (e.g. "post-checkout", "homepage").

Popup Variants

Config	Behavior
`rating: false` (default)	Simple message. Auto-dismisses after 10 seconds. Click to dismiss.
`rating: true`	Message + 5 stars + Submit button. Stars highlight on hover.
`rating: true, feedbackText: true`	Same as above, but a text input appears after selecting a rating.

Locale Resolution

The message parameter is a locale map. The widget shows the message matching the visitor's detected language. If no match exists for the visitor's locale, the popup is not shown.

One at a Time

Only one popup can be shown at a time. Calling createPopup while a popup is visible replaces it.

Viewing Ratings

Submitted ratings are visible in your domain's Ratings tab, with tag filtering and average score.