Loyalty Tier Upgraded

WEBHOOK EVENTS.CUSTOMER.LOYALTY.TIER.UPGRADED

customer.loyalty.tier.upgraded

{
  "customer": {
    "id": "cust_2p0TvCOvB25HWUrW9JFf4czJ",
    "name": "Alex Doe",
    "email": null,
    "source_id": "4l3x-d03",
    "metadata": {},
    "object": "customer"
  },
  "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,
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": null,
    "created_at": "2024-01-18T15:18:38.577Z",
    "updated_at": "2024-02-09T13:04:15.034Z",
    "object": "campaign"
  },
  "loyalty_tier_from": {
    "id": "ltr_0e30613ad01f044515",
    "name": "Loyal silver",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "metadata": {},
    "created_at": "2024-01-24T08:28:02.240Z",
    "updated_at": null,
    "earning_rules": {},
    "rewards": {},
    "config": {
      "points": {
        "from": 151,
        "to": 250
      }
    },
    "points": {
      "from": 151,
      "to": 250
    },
    "object": "loyalty_tier"
  },
  "loyalty_tier_to": {
    "id": "ltr_0e30613ad01f044516",
    "name": "Loyal gold",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "metadata": {},
    "created_at": "2024-01-24T08:28:02.240Z",
    "updated_at": null,
    "earning_rules": {},
    "rewards": {},
    "config": {
      "points": {
        "from": 251,
        "to": 350
      }
    },
    "points": {
      "from": 251,
      "to": 350
    },
    "object": "loyalty_tier"
  },
  "created_at": "2024-03-11T12:06:34.423Z"
}

The EVENTS.CUSTOMER.LOYALTY.TIER.UPGRADED event indicates that a customer has moved to a higher tier or a specific tier in a loyalty campaign.

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

Event data object schema for customer.loyalty.tier.upgraded.

customer · Simple Customer · object · required

Simplified customer data.

Show child attributes

campaign · Simple Campaign · object · required

Simplified campaign data.

Show child attributes

loyalty_tier_from · Loyalty Tier · object · required

Loyalty tier data.

Show child attributes

loyalty_tier_to · Loyalty Tier · object · required

Loyalty tier data.

Show child attributes

created_at · string<date-time> · required

Timestamp representing the date and time when the customer entered a higher loyalty tier.

Example:

"2022-02-25T13:32:08.734Z"

Response

200

Webhook accepted