Incentives #

The Incentives system in Hiro is a powerful tool that enables you to create a variety of incentives to drive and increase player 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,
        }
    }
        
}

The JSON schema defines an incentives object which must contain an individual object for each incentive you wish to define in the system. You can configure as few or as many incentives as needed for your desired gameplay.

PropertyTypeDescription
incentivesstring:IncentiveA map of all incentives.

Each individual incentive is keyed by id and may define the following:

Incentive #

PropertyTypeDescription
typeenumThe type of incentive (0 = unspecified, 1 = invite).
namestringThe name of the incentive.
descriptionstringA description of the incentive.
max_claimsintThe maximum number of times this incentive can be claimed.
max_global_claimsintThe maximum number of times an individual user can claim this incentive ID.
max_recipient_age_secint64The maximum account age that is eligible for this incentive. Useful for restricting invites to new users only.
recipient_rewardRewardThe rewards that the incentive recipient should get.
sender_rewardRewardThe rewards that the incentive sender should get.
max_concurrentintThe maximum number of times this incentive can be created by an individual user.
expiry_duration_secint64The duration, in seconds, before the incentive expires.