Incentives #

The Incentives system in Hiro is a powerful tool that enables you to create a variety of incentives to drive and increase play engagement, retention, and revenue. Incentives can be used to reward players for completing specific tasks, such as logging in daily or completing advanced tutorials, and also to encourage players to spend money in your game.

Customization parameters #

The following JSON represents the customization parameters you can use to configure the default user experience for a particular incentive.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

{
    "incentives": {
        "<incentiveId>": {
            "type": 1,
            "name": "Free Coins Invite",
            "description": "Send 100 free coins to a new player!",
            "max_claims": 1,
            "max_global_claims": 1,
            "max_recipient_age_sec": 86400,
            "recipient_reward": {
              "guaranteed": {
                "currencies": {
                  "coins": {
                    "min": 100
                  }
                }
              }
            },
            "sender_reward": {
              "guaranteed": {
                "currencies": {
                  "gems": {
                    "min": 10
                  }
                }
              }
            },
            "max_concurrent": 1,
            "expiry_duration_sec": 86400,
        }
    }
        
}

Each Incentive is keyed by id and may define the following:

PropertySubpropertyDescription
typeThe type of incentive (0 = unspecified, 1 = invite).
nameThe name of the incentive.
descriptionA description of the incentive.
max_claimsThe maximum number of times this incentive can be claimed.
max_global_claimsThe maximum number of times an individual user can claim this incentive ID.
max_recipient_age_secThe maximum account age that is eligible for this incentive. Useful for restricting invites to new users only.
recipient_rewardA reward object that defines what rewards the incentive recipient gets.
sender_rewardA reward object that defines what rewards the incentive sender gets.
max_concurrentThe maximum number of times this incentive can be created by an individual user.
expiry_duration_secThe duration, in seconds, before the incentive expires.