Set up Piggy Bank using player.verify custom attributes

Last updated: July 10, 2026

Set up Piggy Bank using player.verify custom attributes

To configure a Piggy Bank (for example, a themed variant such as a Dragon Bank), the game must provide Piggy Bank data through the player.verify webhook response.

Required custom attributes

If you use multiple Piggy Bank tiers, send the following numeric custom attributes:

  • PiggyBankTier — numeric

  • PiggyBankBalance — numeric

These values should be returned in the customAttributes object of the player.verify response.

  • PiggyBankTier determines which Piggy Bank tier should be available to the player.

  • PiggyBankBalance is used to display the current Piggy Bank balance in the Hub so it stays aligned with the game state.

When attributes are optional

If Piggy Bank is only available for certain players, it is acceptable not to return these attributes for players who are not eligible.

Example: if Piggy Bank is only available up to level 20, the Piggy Bank attributes can be omitted for players above that range.

Additional setup information needed

Along with the webhook attributes, provide the configuration details required to build the offer, such as:

  • tier definitions

  • prices

  • art assets, if you want custom visuals used in the Hub

Keeping Hub and game state in sync

When a player purchases the Piggy Bank in the Hub, your game should update its own Piggy Bank state based on the item.add webhook.

In particular, if purchasing the Piggy Bank should reset the in-game balance, handle that reset on your side after receiving item.add. This is the recommended way to keep the Hub and game consistent.

Implementation notes

  • All Piggy Bank custom attributes must be numeric.

  • If the game does not return the required attributes, the Hub cannot determine the correct tier or display the synced balance.

  • For webhook field details, refer to the player.verify documentation for customAttributes.