Skip to main content
WEBHOOK
EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.CREATED
{
  "holder": {
    "id": "rh_0f147785a5c966e4b3",
    "object": "redeemable_holder",
    "created_at": "2024-07-19T12:19:07.002Z",
    "campaign_id": "camp_vVk4unz3k4gA023fk9XoSiTh",
    "customer_id": "cust_3yngSdlObyvUtdDcnHiGu6Yx",
    "holder_role": "REFEREE",
    "voucher_type": "DISCOUNT_VOUCHER",
    "campaign_type": "REFERRAL_PROGRAM",
    "redeemable_id": "v_uOrG9tQresN9X51gbAoo0a2vY4MLV9lS",
    "publication_id": null,
    "redeemable_object": "voucher"
  },
  "voucher": {
    "id": "v_uOrG9tQresN9X51gbAoo0a2vY4MLV9lS",
    "code": "REFAPI-mk3",
    "type": "DISCOUNT_VOUCHER",
    "active": true,
    "object": "voucher",
    "campaign": "Referral API",
    "discount": {
      "type": "AMOUNT",
      "effect": "APPLY_TO_ORDER",
      "amount_off": 900
    },
    "metadata": {},
    "holder_id": "cust_33924S073JcRVZJRfychtHhW",
    "created_at": "2024-04-02T13:58:14.081Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0
    },
    "start_date": null,
    "updated_at": "2024-04-02T13:58:25.511Z",
    "campaign_id": "camp_vVk4unz3k4gA023fk9XoSiTh",
    "category_id": "cat_0d7c4d183011d043cc",
    "referrer_id": "cust_33924S073JcRVZJRfychtHhW",
    "expiration_date": null,
    "is_referral_code": true
  },
  "campaign": {
    "id": "camp_vVk4unz3k4gA023fk9XoSiTh",
    "name": "Referral API",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": null,
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "AMOUNT",
        "units": null,
        "effect": "APPLY_TO_ORDER",
        "amount_off": 900
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 3,
        "prefix": "REFAPI-",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "###",
        "postfix": ""
      },
      "loyalty_card": null
    },
    "category": null,
    "metadata": {},
    "auto_join": false,
    "join_once": false,
    "created_at": "2024-04-02T13:58:13.738Z",
    "start_date": null,
    "category_id": "cat_0d7c4d183011d043cc",
    "description": null,
    "campaign_type": "REFERRAL_PROGRAM",
    "expiration_date": null,
    "is_referral_code": true,
    "referral_program": {
      "conversion_event_type": "redemption"
    }
  },
  "customer": {
    "id": "cust_3yngSdlObyvUtdDcnHiGu6Yx",
    "name": null,
    "email": null,
    "object": "customer",
    "metadata": {},
    "source_id": null
  }
}
The EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.CREATED event indicates that a customer has been assigned to a redeemable. This event is used in a webhook configured in Project settings in Voucherify dashboard. This event can be viewed in Voucherify logs or as part of events listed under the List Customer Activity endpoint.
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
holder
object
required
voucher
object
required
campaign
object
required
customer
object
required

Response