Skip to main content
WEBHOOK
EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.DELETED
{
  "holder": {
    "id": "rh_0f212ebadcc51eefea",
    "object": "redeemable_holder",
    "created_at": "2024-07-29T09:21:20.221Z",
    "campaign_id": "camp_vVk4unz3k4gA023fk9XoSiTh",
    "customer_id": "cust_B4WY60nNA1HcAnJj6lnW57a7",
    "holder_role": "REFEREE",
    "voucher_type": "DISCOUNT_VOUCHER",
    "campaign_type": "REFERRAL_PROGRAM",
    "redeemable_id": "v_YdDGS5yBnLCp79vfPbHhkoRrqPwkgyiy",
    "publication_id": null,
    "redeemable_object": "voucher"
  },
  "voucher": {
    "id": "v_YdDGS5yBnLCp79vfPbHhkoRrqPwkgyiy",
    "code": "REFAPI-1L8",
    "type": "DISCOUNT_VOUCHER",
    "active": true,
    "object": "voucher",
    "campaign": "Referral API",
    "discount": {
      "type": "AMOUNT",
      "effect": "APPLY_TO_ORDER",
      "amount_off": 900
    },
    "metadata": {},
    "holder_id": "cust_IW0fOCPJcEnL3XuxONs9YX7P",
    "created_at": "2024-04-02T13:58:14.081Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0
    },
    "start_date": null,
    "updated_at": "2024-07-23T13:36:10.822Z",
    "campaign_id": "camp_vVk4unz3k4gA023fk9XoSiTh",
    "category_id": "cat_0d7c4d183011d043cc",
    "referrer_id": "cust_IW0fOCPJcEnL3XuxONs9YX7P",
    "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_B4WY60nNA1HcAnJj6lnW57a7",
    "name": null,
    "email": null,
    "object": "customer",
    "source_id": "rh_test-03"
  }
}
The EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.DELETED event indicates that a customer has been unassigned from 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

Event data object schema for customer.holder.assignment.deleted.

holder
object
required

Details about the holder of the redeemable.

voucher
object
required

Simplified voucher data.

campaign
object
required

Simplified campaign data.

customer
object
required

Simplified customer data.

Response

Webhook accepted

I