Reward Redemptions Completed

WEBHOOK EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED

customer.reward_redemptions.completed

{
  "customer": {
    "id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "name": "John Demo",
    "email": null,
    "source_id": "130524-01",
    "object": "customer"
  },
  "holder": {
    "id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "name": "John Demo",
    "email": null,
    "source_id": "130524-01",
    "object": "customer"
  },
  "voucher": {
    "id": "v_p7NP2qmQaMXsNHzb9ujPVjqgDJzJ2ccQ",
    "code": "H0h9royZ",
    "loyalty_card": {
      "points": 270,
      "balance": 70
    },
    "type": "LOYALTY_CARD",
    "campaign": "loyalty_1305",
    "campaign_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "is_referral_code": false,
    "holder_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "category_id": null,
    "active": true,
    "created_at": "2024-05-13T10: 24: 01.084Z",
    "updated_at": "2024-05-13T12: 25: 59.587Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 2,
      "redeemed_points": 200
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "campaign": {
    "id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "name": "loyalty_1305",
    "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": false,
    "join_once": true,
    "active": true,
    "category_id": null,
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": null,
    "created_at": "2024-05-13T10: 23: 57.997Z",
    "object": "campaign"
  },
  "reward_redemption": {
    "id": "rewr_N5xhKgV5tJBmJxrtb5YB7V3q",
    "state": "COMPLETED",
    "created_at": "2024-05-13T12: 26: 06.250Z",
    "updated_at": null,
    "voucher_id": "v_p7NP2qmQaMXsNHzb9ujPVjqgDJzJ2ccQ",
    "campaign_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "customer_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "reward_assignment_id": "rewa_7121trqxIdcdPv6ToVwn6JXq",
    "source_id": "r_0ebe369389d0528f1f",
    "source_type": "redemption"
  },
  "reward": {
    "assignment_id": "rewa_7121trqxIdcdPv6ToVwn6JXq",
    "voucher": {
      "id": "v_7cNPiXkbCZJ4SkCil4XFZulEi3Z7ejmD",
      "code": "tKSTdVk2",
      "discount": {
        "type": "PERCENT",
        "amount_limit": 10000,
        "percent_off": 10,
        "effect": "APPLY_TO_ORDER"
      },
      "type": "DISCOUNT_VOUCHER",
      "campaign": "Discount coupon for loyalty",
      "campaign_id": "camp_XqNwzVA81QY0Lw4NsiTp26cT",
      "is_referral_code": false,
      "holder_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
      "category_id": null,
      "active": true,
      "created_at": "2024-05-13T12: 25: 59.630Z",
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "start_date": null,
      "expiration_date": null,
      "metadata": {},
      "object": "voucher"
    },
    "id": "rew_UtRGHxt98jwCzodkskxQ7KLp",
    "object": "reward",
    "name": "10% discount coupon",
    "type": "CAMPAIGN"
  },
  "reward_assignment": {
    "id": "rewa_7121trqxIdcdPv6ToVwn6JXq",
    "reward_id": "rew_UtRGHxt98jwCzodkskxQ7KLp",
    "related_object_id": "camp_wce3U0BUekz2YGVl1F43Tvd4",
    "related_object_type": "campaign",
    "parameters": {
      "loyalty": {
        "points": 100
      }
    },
    "created_at": "2024-05-13T12: 25: 06.389Z",
    "updated_at": null,
    "object": "reward_assignment"
  },
  "source": {
    "id": "r_0ebe369389d0528f1f",
    "type": "redemption"
  },
  "balance": null,
  "publication": {
    "id": "pub_wTfqQlLXnV5VCaBaswHnTOpdjAr8L4l7",
    "object": "publication",
    "created_at": "2024-05-13T12: 25: 59.620Z",
    "customer_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
    "tracking_id": "130524-01",
    "metadata": {},
    "channel": "API",
    "source_id": null,
    "result": "SUCCESS",
    "customer": {
      "id": "cust_2myfc5acSBgoMV72R5tyTBc8",
      "source_id": "130524-01",
      "name": "John Demo",
      "address": null,
      "summary": null,
      "loyalty": null,
      "referrals": null,
      "object": "customer"
    },
    "voucher": {
      "id": "v_7cNPiXkbCZJ4SkCil4XFZulEi3Z7ejmD",
      "code": "tKSTdVk2",
      "campaign": "Discount coupon for loyalty",
      "campaign_id": "camp_XqNwzVA81QY0Lw4NsiTp26cT",
      "category": null,
      "category_id": null,
      "categories": [],
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "amount_limit": 10000,
        "percent_off": 10,
        "effect": "APPLY_TO_ORDER"
      },
      "gift": null,
      "loyalty_card": null,
      "start_date": null,
      "expiration_date": null,
      "validity_timeframe": null,
      "validity_hours": null,
      "validity_day_of_week": null,
      "active": true,
      "additional_info": null,
      "metadata": {},
      "assets": {
        "qr": {
          "id": "045c3e7c-ae97-4bf9-a36f-2846777c2419",
          "url": "{{voucher_qr_code.url}}"
        },
        "barcode": {
          "id": "292a5523-1bff-4387-8d10-5cf8f77cce0e",
          "url": "{{voucher_barcode.url}}"
        }
      },
      "is_referral_code": false,
      "created_at": "2024-05-13T12: 25: 59.630Z",
      "updated_at": "2024-05-13T12: 26: 12.167Z",
      "holder_id": "cust_2myfc5acSBgoMV72R5tyTBc8",
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0,
        "object": "list",
        "url": "/v1/vouchers/tKSTdVk2/redemptions?page=1&limit=10"
      },
      "publish": {
        "object": "list",
        "count": 1,
        "url": "/v1/vouchers/tKSTdVk2/publications?page=1&limit=10"
      },
      "object": "voucher"
    },
    "vouchers_id": [
      "v_7cNPiXkbCZJ4SkCil4XFZulEi3Z7ejmD"
    ]
  }
}

The EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED event indicates that redemption of a reward has been completed.

If this event is sent as a notification in a Loyalty campaign, it is also sent with the publication object.

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 EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED.

customer · Simple Customer · object | null

Simplified customer data.

Show child attributes

holder · Simple Customer · object | null

Details about the redeemable holder.

Show child attributes

voucher · Simple Voucher · object | null

Simplified voucher data.

Show child attributes

campaign · Simple Campaign · object | null

Simplified campaign data.

Show child attributes

reward_redemption · object | null

Details about the redemption of a reward

Show child attributes

reward · Simple Redemption Reward Result · object | null

Simplified redemption reward result data

Show child attributes

reward_assignment · object | null

Details about the assignment of the reward to the customer.

Show child attributes

source · object | null

Show child attributes

balance · object | null

Balance changed by the event.

Show child attributes

publication · Publications with Voucher · object | null

Publication with a voucher.

Show child attributes

Response

200

Webhook accepted