Skip to main content
WEBHOOK
EVENTS.CUSTOMER.REDEMPTION.SUCCEEDED
{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "order": {
    "id": "ord_p6B1A0y805yUQQaCw4bC6Fbk",
    "source_id": null,
    "status": "PAID",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "referrer_id": null,
    "amount": 11499,
    "discount_amount": 1150,
    "applied_discount_amount": 1150,
    "total_discount_amount": 1150,
    "total_applied_discount_amount": 1150,
    "total_amount": 10349,
    "items": [
      {
        "object": "order_item",
        "product_id": "prod_0df14b684f58f282d4",
        "quantity": 1,
        "amount": 3500,
        "price": 3500,
        "subtotal_amount": 3500
      },
      {
        "object": "order_item",
        "product_id": "prod_0de0c540ad917bb410",
        "quantity": 1,
        "amount": 7999,
        "price": 7999,
        "subtotal_amount": 7999
      }
    ],
    "metadata": {},
    "created_at": "2024-03-13T17:35:58.482Z",
    "object": "order"
  },
  "campaign": {
    "id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "name": "Spring Discounts",
    "campaign_type": "DISCOUNT_COUPONS",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "units": null,
        "effect": "APPLY_TO_ORDER",
        "percent_off": 10,
        "amount_limit": 3000,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 3,
        "prefix": "SPRING-2024-",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "###",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": false,
    "active": true,
    "category_id": "cat_0e156dab8f2e43873a",
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": "Spring 2024 big campaign",
    "created_at": "2024-02-21T10:01:24.102Z",
    "updated_at": "2024-03-13T17:35:51.314Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_eaxx9mNFwWZWZGBwkZf3JpN7yJZlU9Y7",
    "code": "SPRING-2024-hOg",
    "discount": {
      "type": "PERCENT",
      "amount_limit": 3000,
      "percent_off": 10,
      "effect": "APPLY_TO_ORDER",
      "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
    },
    "type": "DISCOUNT_VOUCHER",
    "campaign": "Spring Discounts",
    "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": "cat_0e156dab8f2e43873a",
    "active": true,
    "created_at": "2024-03-12T14:41:53.591Z",
    "updated_at": "2024-03-13T17:35:58.530Z",
    "redemption": {
      "quantity": 1,
      "redeemed_quantity": 1
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "holder": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "promotion_tier": null,
  "promotion_stack": null,
  "redemption": {
    "id": "r_0e6ff48b91cfa02e97",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "track_8RFQINPxgc+pykybVOUEXQ==",
    "date": "2024-03-13T17:35:58.535Z",
    "order": {
      "id": "ord_p6B1A0y805yUQQaCw4bC6Fbk",
      "source_id": null,
      "status": "PAID",
      "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "referrer_id": null,
      "amount": 11499,
      "discount_amount": 1150,
      "applied_discount_amount": 1150,
      "total_discount_amount": 1150,
      "total_applied_discount_amount": 1150,
      "total_amount": 10349,
      "items": [
        {
          "object": "order_item",
          "product_id": "prod_0df14b684f58f282d4",
          "quantity": 1,
          "amount": 3500,
          "price": 3500,
          "subtotal_amount": 3500
        },
        {
          "object": "order_item",
          "product_id": "prod_0de0c540ad917bb410",
          "quantity": 1,
          "amount": 7999,
          "price": 7999,
          "subtotal_amount": 7999
        }
      ],
      "metadata": {},
      "created_at": "2024-03-13T17:35:58.482Z",
      "object": "order"
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "name": "Jack Webhook",
      "email": null,
      "source_id": "jck-wbhk",
      "metadata": {
        "region": "EMEA",
        "sign-up": "true"
      },
      "object": "customer"
    },
    "result": "SUCCESS",
    "status": "SUCCEEDED",
    "voucher": {
      "id": "v_eaxx9mNFwWZWZGBwkZf3JpN7yJZlU9Y7",
      "code": "SPRING-2024-hOg",
      "discount": {
        "type": "PERCENT",
        "amount_limit": 3000,
        "percent_off": 10,
        "effect": "APPLY_TO_ORDER",
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "type": "DISCOUNT_VOUCHER",
      "campaign": "Spring Discounts",
      "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
      "is_referral_code": false,
      "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "category_id": "cat_0e156dab8f2e43873a",
      "active": true,
      "created_at": "2024-03-12T14:41:53.591Z",
      "updated_at": "2024-03-13T17:35:58.530Z",
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 1
      },
      "start_date": null,
      "expiration_date": null,
      "metadata": {},
      "object": "voucher"
    },
    "metadata": {
      "location_id": []
    },
    "object": "redemption"
  }
}
The EVENTS.CUSTOMER.REDEMPTION.SUCCEEDED event indicates that the redemption process was successful with regard to a customer. It confirms that the associated voucher codes and promotional tiers have been effectively applied. This event is used in a webhook configured in Distributions 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
customer
object
order
object
campaign
object
voucher
object
holder
object
promotion_tier
object
promotion_stack
object
redemption
object

Response