Create Custom Rewards

Overview

Before using Custom Rewards in Promo campaigns, you must first create the reward configurations that will be triggered via webhooks.

You can create the following two types of Custom Rewards:

Create Physical & Digital Rewards

Physical & Digital Rewards manage external digital or physical rewards such as vouchers, gift cards, or merchandise.

To create a Physical & Digital Reward, perform the following steps:

  1. Go to Promo > Rewards > Webhook Rewards > Physical & Digital Reward.

  2. Click Add reward configuration.

  3. In the creation modal, fill in the following details:

    • Client Reward ID: A unique identifier from your system. This value is case-sensitive and must not duplicate an existing reward.
    • Client Reward Name: The name of the reward.
    • Client Reward Description: Optional details about the reward.
    • Reward Expiry: Choose Never Ends or a specific date.
  4. Click Save.

Add Reward Configuration

Add Reward Configuration

Create Self-managed Wallet Credits

Self-managed Wallet Credits represent real money or point-based rewards managed in an external wallet.

To create a Webhook Wallet, perform the following steps:

  1. Go to Promo > Rewards > Webhook Rewards > Self-managed Wallet Credits.

  2. Click Add Wallet Configuration.

  3. In the creation modal, fill in the following details:

    • Wallet ID: A unique external wallet ID from your system. This value is case-sensitive and must not duplicate an existing reward.
    • Wallet Name: The display name of the wallet.
  4. Click Save.

Add Wallet Configuration

Add Wallet Configuration

JSON Payloads

The following is an example payload for both types of custom rewards:

{
  "profiles": {
    "email": "[email protected]",
    "identity": "foo",
    "phone": "+919538784114",
    "objectId": "g55b74fb10307"
  },
  "reward": {
    "clientRewardId": "110303",
    "clevertapRewardId": "20303",
    "rewardName": "PVR MOVIE TICKET",
    "rewardDescription": "Free PVR Movie ticket",
    "campaignId": 123494
  },
  "customMetadata": {
    "metadata key1": "value1",
    "metadata key2": "value2"
  }
}
{
  "profiles": {
    "email": "[email protected]",
    "identity": "foo",
    "phone": "+919538784114",
    "objectId": "g55b74fb10307"
  },
  "reward": {
    "clientRewardId": "110303",
    "clevertapRewardId": "20303",
    "rewardName": "PVR MOVIE TICKET",
    "rewardDescription": "Free PVR Movie ticket",
    "campaignId": 123494
  },
  "customMetadata": {
    "metadata key1": "value1",
    "metadata key2": "value2"
  }
}