Skip to main content
WEBHOOK
EVENTS.CUSTOMER.LOYALTY.TIER.DOWNGRADED
{
  "customer": {
    "id": "cust_154FDQKcbzygdo231M62r4CD",
    "name": "Alex Doe",
    "email": null,
    "source_id": "4lx-d03",
    "metadata": {
      "region": "EMEA"
    },
    "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": false,
    "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-03-14T10:01:16.596Z",
    "object": "campaign"
  },
  "loyalty_tier_from": {
    "id": "ltr_0e30613ad01f044517",
    "name": "Loyal Star Platinum",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "metadata": {},
    "created_at": "2024-01-24T08:28:02.240Z",
    "updated_at": "2024-03-14T10:01:17.717Z",
    "earning_rules": {
      "ern_FQxftbKUq9E93k00Z3qkC0sX": {
        "type": "MULTIPLY",
        "multiplier": 1
      }
    },
    "rewards": {},
    "config": {
      "points": {
        "from": 351
      }
    },
    "points": {
      "from": 351
    },
    "object": "loyalty_tier"
  },
  "loyalty_tier_to": {
    "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"
  },
  "created_at": "2024-03-14T10:08:14.814Z"
}
The EVENTS.CUSTOMER.LOYALTY.TIER.DOWNGRADED event indicates that a customer has moved to a lower 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.downgraded.

customer
object
required

Simplified customer data.

campaign
object
required

Simplified campaign data.

loyalty_tier_from
object
required

Loyalty tier data.

loyalty_tier_to
object
required

Loyalty tier data.

created_at
string<date-time>
required

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

Example:

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

Response

Webhook accepted

I