Skip to main content
POST
/
EVENTS.CUSTOMER.REWARDED.LOYALTY_POINTS
{
  "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": 0,
      "balance": 0
    },
    "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:19:26.501570Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0,
      "redeemed_points": 0
    },
    "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"
  },
  "loyalty_tier": null,
  "earning_rule": {
    "id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
    "created_at": "2024-01-18T15:18:39.156632Z",
    "updated_at": null,
    "validation_rule_id": null,
    "loyalty": {
      "type": "PROPORTIONAL",
      "calculation_type": "ORDER_TOTAL_AMOUNT",
      "order": {
        "total_amount": {
          "every": 500,
          "points": 10
        }
      }
    },
    "event": "order.paid",
    "source": {
      "banner": "Order-paid",
      "object_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
      "object_type": "campaign"
    },
    "active": true,
    "object": "earning_rule",
    "automation_id": "auto_sRc6onPl70seyfrGOXhwDxYE",
    "metadata": {}
  },
  "balance": {
    "type": "loyalty_card",
    "total": 900,
    "object": "balance",
    "points": 900,
    "balance": 900,
    "operation_type": "AUTOMATIC",
    "related_object": {
      "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
      "type": "voucher"
    }
  },
  "order": {
    "id": "ord_CkH2s0T5xJkK0x5pGYXoBaFn",
    "source_id": null,
    "created_at": "2024-01-18T15:19:20.675043Z",
    "updated_at": "2024-01-18T15:19:20.731920Z",
    "status": "PAID",
    "amount": 50000,
    "discount_amount": 5000,
    "total_discount_amount": 5000,
    "total_amount": 45000,
    "items": [
      {
        "object": "order_item",
        "product_id": "prod_0df14b7e7d8975079d",
        "quantity": 20,
        "amount": 50000,
        "price": 2500,
        "subtotal_amount": 50000,
        "product": {
          "id": "prod_0df14b7e7d8975079d",
          "source_id": "star-th-bottle",
          "name": "Star Thermal Bottle",
          "price": 2500
        }
      },
      {
        "object": "order_item",
        "product_id": "prod_5h1pp1ng",
        "quantity": 1,
        "amount": 0,
        "price": 0,
        "subtotal_amount": 0,
        "product": {
          "id": "prod_5h1pp1ng",
          "source_id": "5h1pp1ng",
          "name": "Shipping"
        }
      }
    ],
    "metadata": {
      "card": [
        "Other"
      ],
      "region": "US",
      "currency": "USD"
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "address": null,
      "summary": null,
      "loyalty": null,
      "referrals": null,
      "object": "customer"
    },
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "referrer_id": null,
    "object": "order",
    "redemptions": {
      "r_0e2905d4e6985a04b5": {
        "date": "2024-01-18T15:19:20.731Z",
        "related_object_type": "promotion_tier",
        "related_object_id": "promo_aKUQomRfnj47MHoOV8XcNmO1",
        "related_object_parent_id": "camp_7xzcWMVIefoujUIpuwwrHxIU"
      }
    }
  },
  "event": {
    "id": "evcus_0e2905d4db185a04ad",
    "type": "customer.order.paid",
    "category": "EFFECT",
    "entity_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "created_at": "2024-01-18T15:19:20.676Z",
    "group_id": "v-0e2905d4bb0dcc9e62"
  }
}

Response

200 - application/json

Indicates that a customer has received loyalty points.

Event data object schema for customer.rewarded.loyalty_points.

​
customer
object

Simplified customer data.

​
holder
object

Details about the redeemable holder.

​
voucher
object

Simplified voucher data.

​
campaign
object

Simplified campaign data.

​
loyalty_tier
object

Loyalty tier data.

​
earning_rule
object

Earning rule data.

​
balance
object

Contains information on how the balance was affected by the transaction.

​
order
object

Order information.

​
event
object

Simplified event data.

​
publication
object

Publication with a voucher.

⌘I