Documentation Index

Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt

Use this file to discover all available pages before exploring further.

Quiz

Prev Next

An overview of the Quiz game and the game campaign setup process.

Game overview

Quiz is a timed, multiple-choice question and answer game. Players are presented with a set of questions, and how many they answer correctly determines whether, and what, they win.

Quiz uses a three-level structure: Campaign > Round > Question.

Campaigns are made up of one or more rounds, where each round can include one or more questions. Players work through the questions one at a time against a countdown timer. With no feedback on whether an individual answer is right or wrong, once a player has answered all questions in the round they discover if they; win a prize, get a chance to retry, or find themselves locked out. Depending on how you set the game up, being locked out could mean not being able to play; for the rest of that round, until a specific round of your choosing, or even for the rest of the campaign. If a player does get the chance to retry, they'll need to answer every question again with no memory of which answers were right or wrong last time.

Whether a player wins a prize also depends on the customer segment they belong to and the promotion you've linked to that prize, in addition to their number of correct answers. For more information, see Prizes in Quiz below.

Quiz is built and managed entirely within the Xtremepush platform, and prizes are linked to your existing promotions and segments, for example free spins or bonus cash tied to your bonus engine.

Quiz also supports awarding the player a turn on another game in your account (for example, a wheel) instead of a standard promotion.

Prerequisites of game setup

  • User Segments: To target your quiz and its prizes to specific players, you need pre-configured segments. Create these on the Xtremepush platform before you start. For more information, see Before You Create a Game Campaign.

  • Promotions: Prizes in Quiz are awarded through your existing Xtremepush promotions. Create the promotion(s) you want to award before you configure your prizes.

  • Downstream Game (optional): If you plan to award a turn on another game as a prize, set up that game first.

  • Game Assets: Prepare any answer images you want to use, plus branded assets for the quiz interface.

Setup process overview

The following sections provide a high-level overview of the steps required to set up a Quiz game, with links to more detailed documentation.

The infographic below highlights the four key stages of the game launch workflow, from creation to monitoring:

Create Campaign

Define the rules of your new quiz.

✏️

⚙️

Configure Mechanics

Set up rounds, questions, and prizes.

Customise Design

Replace assets and update texts.

🎨

🚀

Launch & Monitor

Embed your game and view player activity.

Create your game campaign

This relates to a single instance of the game, with a start and end date, timezone, and player eligibility rules.

In the Campaign Settings tab, configure the overall rules for your quiz:

  • Starts At and Ends At: The window during which the campaign, and its rounds, can run.

  • Timezone: The timezone used to evaluate round start and end dates.

  • Default Segment: This ensures the players you want to gain access are eligible to play the game, should your more targeted segmentation miss them.

  • Excludes Segment: Segments you don't want to allow into the quiz at all. Players in an excluded segment see an ineligible state and can't play.

  • Externally Configure Play Limits: Turn this on only if play eligibility (rounds, attempts) is managed by an external system, an API or your bonus engine, instead of the round settings below. Most operators don't need this.

  • CSS: Optional custom CSS to override the quiz's default styling.

Configure game mechanics

Rounds

Each campaign is made up of one or more Rounds. A round is a discrete period, such as a day, week or a month, with its own set of questions and its own record of player attempts. All player progress for a round, including which questions they've answered and how many incorrect attempts they've made, resets when a new round starts.

Configure the following at Round level:

  • Starts At and Ends At.

  • Disabled: Temporarily disable the round without deleting it.

  • Retry cooldown hours: How long a player must wait after an incorrect submission before they can try again.

  • Max incorrect attempts: The number of incorrect submissions allowed before a player is locked out.

  • Lock Expiry Type: What happens once a player reaches Max incorrect attempts. Choose from:

    • End Of Round (default): The player can try again as soon as the next round starts.

    • End Of Campaign: The player is locked out for the remainder of the campaign, regardless of how many rounds remain.

    • Start Of Specific Round: The player is locked out until a round you specify becomes active.

A few points on player behaviour worth knowing when you're configuring rounds:

  • If a player doesn't answer before the timer runs out, it's treated as an incorrect answer and the player automatically moves to the next question.

  • If a player retries after a cooldown, they must answer every question in the round again. Previously correct answers aren't carried over or shown, so a player can't infer answers from an earlier attempt.

  • If a player closes their browser mid-round, their progress is saved. They resume from the first unanswered question when they return.

  • If a round ends while a player is mid-quiz, their submission is rejected and no attempt is recorded.

  • Players move through questions in one direction only. There's no option to go back to a previous question.

  • Players see a progress indicator (for example, "Question 2 of 5") as they move through the round.

Correct answers are tallied per round: once a player submits every question in a round, that round's correct-answer count decides whether, and what, they win. If they answer incorrectly, they can retry after a configurable cooldown period, up to a configurable number of attempts, after which they're locked out until the point you have defined.

Questions

Each round contains one or more individual multiple-choice questions with a configurable timer and answer options.

You can configure the following per question:

  • Question text.

  • Timer seconds: How long the player has to answer.

  • Order: Optionally set the order questions appear in. If you leave this unset, order isn't guaranteed.

  • Disabled: Temporarily disable the question without deleting it.

Each question needs at least two Answer Options, managed from the question's answer list. Each answer has its own text, an optional image (uploaded directly against the answer), and an Is Correct Answer flag. Answer options are shown to each player in a random order; question order, if you've set one, is not randomised.

Prizes in Quiz

Prizes are configured once per campaign, not per round, but evaluated fresh every time a player submits a round. Each prize in the Prizes tab links a correct-answer threshold to an existing Xtremepush promotion:

  • Name: An internal reference name for the prize.

  • Customer Segment: The segment this prize applies to.

  • Starts At and Ends At: An optional validity window for the prize, separate from any round's own dates. A prize can be won more than once across the campaign, once per qualifying round, for as long as the prize's own date window is active. To prevent the same prize being won multiple times you should align the available date window for that prize with the specific round you want to have that prize available for.

  • Promotion: The existing Xtremepush promotion this prize awards. Create the promotion before you configure the prize, it won't appear here otherwise.

  • Min correct answers: The minimum number of correct answers, within the round just submitted, a player needs to qualify for this prize. The game will always default to the prize which has the highest minimum that the player achieved (e.g. if the player scored 3 correct answers they will be given the prize who’s minimum is 3, but not 2 or 1). If two prizes share an identical threshold and segment, the player gets both, there's no logic built into the game to decide which individual one they receive.

Because the same prize list applies to every round in the campaign, a player is re-evaluated against it each time they complete a round, using that round's own correct-answer count. If you want different outcomes for the same segment at different scores, add multiple prize entries with different Min correct answers values, each pointing at a different promotion. A player who doesn't meet any configured threshold receives no prize.

Manage time slots (optional)

Optionally restrict when the quiz is playable using the Time Slots tab. Configure specific windows during which players can access the quiz; outside these windows, the quiz shows as unavailable.

Disable a game using time slots

Time slots are also a quick way to temporarily close the quiz without removing it from your site, for example during maintenance. Change a time slot's hours to tell players when to come back.

Make design changes to your game

After you create the campaign, customise the quiz's visual design and text to match your brand. This involves three key areas:

  • Replace or Add Assets: The template you select provides a standard asset pack. You have two options for customisation:

    • Replace any of the default assets with your own branded versions. For more information, see Replace Assets.

    • Add new assets that are not part of the standard pack. For more information, see Manage Assets. For a general overview of game assets, see Assets Overview.

  • Update Game Texts: In the Texts tab, update the system and eligibility messages players see, for example Player not eligible, Round expired, Campaign not started, Already Played, and similar states. This covers error and eligibility states rather than the in-game question flow itself. For more information, see Update Texts.

Launch and monitor game

Launch your game

Each Quiz game has its own JWT Auth Secret, set in the game's Configuration tab (outside any individual campaign). This is used to authenticate players when the quiz is embedded on your site or app.

Monitor player activity

The Xtremepush platform tracks player activity for the Quiz game, which you can view in the Games tab of your campaign, including:

  • The Customer ID of every player who attempted the quiz.

  • The Prize they won, if any, and the Customer Segment they belonged to.

  • Timestamps for when their attempt was Created At, Submitted At, and Accepted At.