Reward Redemptions Created

WEBHOOK EVENTS.CUSTOMER.REWARD_REDEMPTIONS.CREATED

customer.reward_redemptions.created

{
  "holder": {
    "id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "name": "John Demo",
    "email": null,
    "object": "customer",
    "source_id": "130524-01"
  },
  "reward": {
    "id": "rew_6cXu5JUKsjDo1T1LmFLF3eML",
    "name": "reward",
    "type": "CAMPAIGN",
    "object": "reward",
    "product": {
      "id": "prod_0d460f397b92a82905",
      "name": "laptop",
      "source_id": "laptop_123"
    },
    "assignment_id": "rewa_W4BkaZz7mOwwzlIMfBVQJo0j"
  },
  "source": {
    "id": "r_0ebe386a24c311bff7",
    "type": "redemption"
  },
  "balance": null,
  "voucher": {
    "id": "v_p7NP2qmQaMXsNHzb9ujPVjqgDJzJ2ccQ",
    "code": "H0h9royZ",
    "type": "LOYALTY_CARD",
    "active": true,
    "object": "voucher",
    "campaign": "loyalty_1305",
    "metadata": {},
    "holder_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "created_at": "2024-05-13T10:24:01.084Z",
    "redemption": {
      "quantity": null,
      "redeemed_points": 300,
      "redeemed_quantity": 3
    },
    "start_date": null,
    "updated_at": "2024-05-13T12:34:01.487Z",
    "campaign_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "category_id": null,
    "loyalty_card": {
      "points": 370,
      "balance": 70
    },
    "expiration_date": null,
    "is_referral_code": false
  },
  "campaign": {
    "id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "name": "loyalty_1305",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": null,
      "type": "LOYALTY_CARD",
      "discount": null,
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 8,
        "prefix": "",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "########",
        "postfix": ""
      },
      "loyalty_card": {
        "points": 0
      }
    },
    "category": null,
    "metadata": {},
    "auto_join": false,
    "join_once": true,
    "created_at": "2024-05-13T10:23:57.997Z",
    "start_date": null,
    "category_id": null,
    "description": null,
    "campaign_type": "LOYALTY_PROGRAM",
    "expiration_date": null,
    "is_referral_code": false
  },
  "customer": {
    "id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "name": "John Demo",
    "email": null,
    "object": "customer",
    "source_id": "130524-01"
  },
  "reward_assignment": {
    "id": "rewa_W4BkaZz7mOwwzlIMfBVQJo0j",
    "object": "reward_assignment",
    "reward_id": "rew_6cXu5JUKsjDo1T1LmFLF3eML",
    "created_at": "2024-05-13T12:33:21.652Z",
    "parameters": {
      "loyalty": {
        "points": 100
      }
    },
    "updated_at": null,
    "related_object_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "related_object_type": "campaign"
  },
  "reward_redemption": {
    "id": "rewr_23IX6dCFJe03AX4M56KcI95D",
    "state": "PENDING",
    "source_id": "r_0ebe386a24c311bff7",
    "created_at": "2024-05-13T12:34:10.464Z",
    "updated_at": null,
    "voucher_id": "v_p7NP2qmQaMXsNHzb9ujPVjqgDJzJ2ccQ",
    "campaign_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "customer_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "source_type": "redemption",
    "reward_assignment_id": "rewa_W4BkaZz7mOwwzlIMfBVQJo0j"
  }
}

The EVENTS.CUSTOMER.REWARD_REDEMPTIONS.CREATED event indicates that redemption of a reward has been created.

This event is used in a webhook configured in Project settings in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.reward_redemptions.

customer · Simple Customer · object

Simplified customer data.

Show child attributes

holder · Simple Customer · object

Details about the redeemable holder.

Show child attributes

voucher · Simple Voucher · object

Simplified voucher data.

Show child attributes

campaign · Simple Campaign · object

Simplified campaign data.

Show child attributes

reward_redemption · object

Details about the redemption of a reward

Show child attributes

reward · Simple Redemption Reward Result · object

Simplified redemption reward result data

Show child attributes

reward_assignment · object

Details about the assignment of the reward to the customer.

Show child attributes

source · object

Show child attributes

balance · object

Balance changed by the event.

Show child attributes

Response

200

Webhook accepted