Rewarded

post https://example.com/EVENTS.CUSTOMER.REWARDED

EVENT: "EVENTS.CUSTOMER.REWARDED"
HTTP method: POST

The EVENTS.CUSTOMER.REWARDED event indicates that a customer received a reward in exchange for points in a loyalty campaign. The action is usually a manual process started by the customer.

This event is used in a webhook configured in Distributions in Voucherify dashboard.

📘
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: customer.rewarded

{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA"
    },
    "object": "customer"
  },
  "holder": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA"
    },
    "object": "customer"
  },
  "voucher": {
    "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
    "code": "L0y4L",
    "loyalty_card": {
      "points": 900,
      "balance": 850
    },
    "type": "LOYALTY_CARD",
    "campaign": "Loyalty programme",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": null,
    "active": true,
    "created_at": "2024-01-18T15:18:39.015000Z",
    "updated_at": "2024-01-18T15:27:56.228461Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 1,
      "redeemed_points": 50
    },
    "object": "voucher"
  },
  "campaign": {
    "id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "name": "Loyalty programme",
    "campaign_type": "LOYALTY_PROGRAM",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "LOYALTY_CARD",
      "loyalty_card": {
        "points": 0
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 8,
        "prefix": "",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "########",
        "postfix": ""
      }
    },
    "auto_join": true,
    "join_once": true,
    "active": true,
    "category_id": null,
    "created_at": "2024-01-18T15:18:38.577044Z",
    "object": "campaign"
  },
  "redemption": {
    "id": "r_0e2907cc52498573ee",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "track_8RFQINPxgc+pykybVOUEXQ==",
    "date": "2024-01-18T15:27:56.234000Z",
    "amount": 50,
    "order": {
      "id": "ord_8GGVSci7FUPX1UX94qBHQPSE",
      "source_id": null,
      "status": "PAID",
      "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "referrer_id": null,
      "amount": 2900,
      "total_amount": 2900,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0df14b684f58f282d4",
          "quantity": 1,
          "amount": 2900,
          "price": 2900,
          "subtotal_amount": 2900
        }
      ],
      "metadata": {},
      "created_at": "2024-01-18T15:27:56.175354Z",
      "object": "order"
    },
    "reward": {
      "customer": {
        "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
        "name": "Jack Webhook",
        "email": null,
        "source_id": "jck-wbhk",
        "metadata": {
          "region": "EMEA"
        },
        "object": "customer"
      },
      "assignment_id": "rewa_XiIei2UpOYkLQxZ4J3U2pYlK",
      "product": {
        "id": "prod_0df14b7e7d8975079d",
        "source_id": "star-th-bottle",
        "name": "Star Thermal Bottle"
      },
      "id": "rew_oOrlSAeYmfh6gYGOH7JMYVzv",
      "object": "reward",
      "name": "Material",
      "created_at": "2024-01-18T15:17:20.072326Z",
      "updated_at": null,
      "parameters": {
        "product": {
          "id": "prod_0df14b7e7d8975079d",
          "sku_id": null
        }
      },
      "type": "MATERIAL"
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "name": "Jack Webhook",
      "email": null,
      "source_id": "jck-wbhk",
      "metadata": {
        "region": "EMEA"
      },
      "object": "customer"
    },
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "voucher": {
      "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
      "code": "L0y4L",
      "loyalty_card": {
        "points": 900,
        "balance": 850
      },
      "type": "LOYALTY_CARD",
      "campaign": "Loyalty programme",
      "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "is_referral_code": false,
      "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "category_id": null,
      "active": true,
      "created_at": "2024-01-18T15:18:39.015000Z",
      "updated_at": "2024-01-18T15:27:56.228461Z",
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 1,
        "redeemed_points": 50
      },
      "object": "voucher"
    },
    "metadata": {
      "location_id": []
    },
    "object": "redemption"
  },
  "reward": {
    "assignment_id": "rewa_XiIei2UpOYkLQxZ4J3U2pYlK",
    "product": {
      "id": "prod_0df14b7e7d8975079d",
      "source_id": "star-th-bottle",
      "name": "Star Thermal Bottle"
    },
    "id": "rew_oOrlSAeYmfh6gYGOH7JMYVzv",
    "object": "reward",
    "name": "Material",
    "type": "CAMPAIGN"
  },
  "referral_tier": null,
  "balance": null,
  "custom_event": null,
  "customer_event": null
}

Response

Response body

object

customer

object | null

Simplified customer data.

string

Unique identifier of an existing customer. It is assigned by Voucherify.

name

string

Customer's first and last name.

string

Customer's email address.

source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

Has additional fields

object

string

The type of the object represented by JSON.

customer

holder

object | null

Details about the redeemable holder.

string

Unique identifier of an existing customer. It is assigned by Voucherify.

name

string

Customer's first and last name.

string

Customer's email address.

source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

Has additional fields

object

string

The type of the object represented by JSON.

customer

voucher

object | null

Simplified voucher data.

string

A unique identifier that represents the voucher assigned by Voucherify.

code

string

required

Voucher code.

gift

object

Contains current gift card balance information.

discount

object

Contains information about discount.

loyalty_card

object

Simplified loyalty card data.

type

string

required

Type of the voucher.

DISCOUNT_VOUCHER LOYALTY_CARD GIFT_VOUCHER

campaign

string

Campaign name.

campaign_id

string

Campaign unique ID.

is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

holder_id

string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

category_id

string | null

Unique identifier of the category that this voucher belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

object

string

required

Defaults to category

The type of the object represented by the JSON. This object stores information about the category.

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

created_at

date-time

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

redemption

object

Defines the redemption limits on vouchers.

start_date

date-time

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

expiration_date

date-time

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

Has additional fields

object

string

required

Defaults to voucher

The type of the object represented by JSON.

voucher

campaign

object | null

Simplified campaign data.

string

Campaign ID.

name

string

Campaign name.

campaign_type

string

Type of campaign.

type

string

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
STATIC: vouchers need to be manually published
STANDALONE: campaign for single vouchers

AUTO_UPDATE STATIC STANDALONE

is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

voucher

object

Simplified campaign voucher data.

referral_program

object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

auto_join

boolean

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

join_once

boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them. It is always true for loyalty campaigns.

active

boolean

Indicates whether the campaign is active.

category_id

string | null

The unique category ID that this campaign belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

object

string

required

Defaults to category

The type of the object represented by the JSON. This object stores information about the category.

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

metadata

object

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

Has additional fields

start_date

date-time

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

expiration_date

date-time

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

description

string

An optional field to keep extra textual information about the campaign such as a campaign description and details.

created_at

date-time

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.

object

string

Defaults to campaign

The type of the object represented by JSON. This object stores information about the campaign.

campaign

redemption

object | null

Redemption data used for internal communication

string

Unique redemption ID.

object

string

Defaults to redemption

The type of the object represented by the JSON. This object stores information about the redemption.

created_at

date-time

Timestamp representing the date and time when the redemption was created in the ISO 8601 format.

tracking_id

string

Hashed customer source ID.

metadata

object

The metadata object stores all custom attributes assigned to the redemption.

Has additional fields

channel_type

string

The source of the channel for the redemption rollback. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API.

USER API

channel_id

string

Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API.

failure_code

string

If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.

failure_message

string

If the result is FAILURE, this parameter will provide an expanded reason as to why the redemption failed.

order

object

Order information.

previous_order

object

Order information.

reward

object

amount

integer

For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.
For loyalty cards, this is the number of loyalty points used in the transaction.
In the case of redemption rollback, the numbers are expressed as negative integers.

reason

string

System generated cause for the redemption being invalid in the context of the provided parameters.

result

string

Redemption result.

SUCCESS FAILURE

status

string

Redemption status.

SUCCEEDED FAILED

related_redemptions

object

parent_redemption_id

string

Unique redemption ID of the parent redemption.

redemption

string

Unique redemption ID of the parent redemption.

customer

object

Simplified customer data.

customer_id

string | null

Unique customer ID of the redeeming customer.

related_object_type

string

Defines the related object.

voucher promotion_tier

related_object_id

string

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

related_object_parent_id

string

Unique related parent object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

campaign_name

string

Campaign name

voucher

object

Object representing a voucher.

promotion_tier

object

Object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.

reward

object | null

Simplified redemption reward result data

customer

object

Simplified customer data.

assignment_id

string

Unique reward assignment ID assigned by Voucherify.

voucher

object

Defines the voucher reward.

product

object

Defines the product reward.

sku

object

Defines the SKU reward.

loyalty_tier_id

string

Unique loyalty tier ID assigned by Voucherify.

string

Unique reward ID, assigned by Voucherify.

object

string

Defaults to reward

The type of the object represented by the JSON. This object stores information about the reward.

reward

name

string

Reward name.

created_at

date-time

Timestamp representing the date and time when the reward was created in the ISO 8601 format.

updated_at

date-time | null

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.

parameters

object

Defines how the reward is generated.

metadata

object

A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.

Has additional fields

type

string

Reward type.

CAMPAIGN COIN MATERIAL

referral_tier

object | null

Simplified referral tier data.

string

Unique referral tier ID.

campaign_id

string

Campaign ID.

banner

string

Text displayed to customers on the website.

parameters

object

Referral tier parameters.

balance

object | null

Balance changed by the event.

amount

integer

Gift card amount changed by the event.

points

integer

Number of loyalty card points changed by the event.

custom_event

object | null

Details about the custom event.

string

Unique custom event ID.

object

string

required

Defaults to event

The object represented is an event.

event

type

string

required

The event name.

customer

object

required

Simplified customer data with limited properties used in Event Tracking endpoints.

referral

object

required

Referral object.

loyalty

object

required

Loyalty object.

metadata

object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer object.

Has additional fields

created_at

date-time

Timestamp representing the date and time when the custom event was created in the ISO 8601 format.

customer_event

object | null

segment

object

Simplified segment data.

event_type

string

Type of activity that triggered the event.

Language


     --url https://example.com/EVENTS.CUSTOMER.REWARDED \

Click Try It! to start a request and see the response here! Or choose an example:

application/json

EVENT: "EVENTS.CUSTOMER.REWARDED"HTTP method: POST

📘Webhook documentation

Example: customer.rewarded

200Indicates that a customer has received a reward.

EVENT: "EVENTS.CUSTOMER.REWARDED"
HTTP method: POST

📘
Webhook documentation