Step 5: Achievement rewards

Achievement Rewards lets you trigger a Reward for players, based on rules. Setting a Reward is optional. You can create multiple Rewards for an Achievement. To create a Reward, click Add and fill in the information, as in the screenshot example.

To create a reward that will be issued to a player, you need to fill out the details. Information such as Name and Description is for the player to see when they receive the reward. Other information such as value, expires in, etc. configures the Reward.

REWARD fields

EXAMPLES

» Name String

Mandatory

The Name of the Reward, visible to the player via the front end.

» Value Double

Mandatory

A Reward value, e.g. if the Reward is 5 free spins, then you enter 5 as the value.

» Type String

Mandatory

Select a reward type that you pre-created. Reward types are used for categorization and automation.

Reward types can be created in Settings → Reward Types. You can read how to create Reward types here.

» Description String

Optional

The description of the Reward can be seen by the player on the front end.

» Expires In Integer

Optional

The number of minutes until the reward expires after it is issued. You can use this to configure time-limited Rewards that are displayed to the player.

» Expires on a specific date DateTime

Optional

Date and time when the reward will no longer be issued

Please note that Expires In and Expires on a specific date cannot both be selected together

» Acknowledgement to issue required Boolean

Mandatory

Specifies if the Reward is issued immediately and automatically, or if it must be claimed manually.

You can build a front end experience for customers to claim Rewards using the Public API. See Claim Member Award by Reference ID POST api/v1/:space/members/reference/:memberRefId/award/:awardId/award

» Metadata Array[Object]

Optional

Optional information for your backend systems.

APP Example:

Name	Free Spin
Value	1
Type	Badge
Description	You get 1 Free spin!
Expires in	N/A
Expires on a specific date	N/A
Acknowledgement to issue required	No
Metadata: Key	Login
Metadata: Value	1

API Example:

{
    "rewards": [
        "jsonClass": "Reward",
        "entityId": "Yi4SqWwB2ogi940JXPDl",
        "rewardRank": "",
        "rewardName": "Free Spin",
        "value": 1,
        "rewardType": "FsjwdGsBmxo4zyGh_nsK",
        "description": "You get 1 Free spin!",
        "memberAcknowledgmentRequired": false,
        "metadata": [
            {
                "jsonClass": "Metadata",
                "key": "Login",
                "value": "1"
            }
        ],
        "accountId": "E8jwdGsBmxo4zyGh9Hs7",
        "pointInTime": "2019-08-19T08:50:48.675+00:00",
        "period": 0
        "created": "2019-08-19T08:50:48.690+00:00",
        "id": "Yy4SqWwB2ogi940JXPDy"
        ],
    "achievement": {
    ...
}

The API example provides only a simplified version of the POST body. A full example of POST Achievement can be found in the Achievements APP API documentation here.

CONTINUE – Click Save to create the Reward in the Achievement.

MISSING ENTRIES

If any mandatory fields are missing, the field is shown in red as in the example below.

The example below shows a created Reward.

You can then use the action buttons:

Reward details – to preview what kind of reward is created.
Edit – to edit the Reward.
Delete – to delete the Reward.

PREVIOUS – Click Previous and go back to the previous step.

CONTINUE – Click Next and continue to the next step.