Skip to main content

External games

An external game is an HTML5 game (yours or an agency's) that runs isolated in the member portal. The game provides the visuals and the server decides the prize. Menu: Engagement › Games, game type External.

Availability

Games permission (with Creating Game and Editing Game) · Enterprise edition ("External Games Catalog" feature).

How it works​

  1. You create a game of type External and assign it a bundle (a .zip with an index.html) or a runner from the gallery.
  2. The game loads in an isolated iframe: it can only run scripts, with no access to the portal page.
  3. When it finishes, the game sends a signal with its score.
  4. The server validates the signal and runs the prize draw just as in the rest of the games.

Because the result is decided on the server, a player cannot change the prize from their browser.

Create an external game​

  1. Go to Engagement › Games and click Create New.
  2. Fill in Name and choose External in Game type. Save.
  3. Open the game with Edit. In the External HTML5 game panel:
    • Game bundle: upload the .zip with Upload bundle (.zip) (maximum 25 MB) or paste an https:// URL.
    • Ready-made runners: pick a ready-made runner with one click.
    • Signal schema (advanced): JSON schema of the signal. If blank it uses {"score":"number"}.
    • Minimum score for prize (skill gate): minimum score to qualify for a prize.
  4. Add the Prizes and their probabilities, as in Games.
  5. Change the Status to Active and pick the game in your campaign.

These panel texts are shown in English.

Minimum score for prize​

  • 0 (default): the score is informational only and the prize is decided by the draw. This is recommended for any bundle.
  • Greater than 0: only a play with a signed score equal to or above it qualifies for a prize. The bundle must implement session signing.
warning

A determined player could forge their score. Use the threshold only with low-value prizes and trusted bundles.

Public leaderboard​

The Public leaderboard panel lets you publish the top 10 of the last 30 days on the landing page, showing only first name and the initial of the surname.

States and limits​

  • Maximum 10 plays per member and game each hour.
  • The bundle must be hosted on an allowed https origin.
  • The Flutter mobile app does not show external games yet; only the web portal does.

Permissions​

ActionPermission (UI text)Technical id
View the screenGamesPages.Gamification.Games
CreateCreating GamePages.Gamification.Games.Create
EditEditing GamePages.Gamification.Games.Edit

If you are building the game​

This page is for whoever configures it. The signal contract, the SDK and the examples are in the developer documentation: