Skip to main content
WEBHOOK
EVENTS.VOUCHER.LOYALTY_CARD.POINTS_EXPIRED
{
  "voucher": {
    "id": "v_66qyRgwumJomTSV2NvkCBa05lP0UOn82",
    "code": "vyOsbgzj",
    "loyalty_card": {
      "points": 1000,
      "balance": 970,
      "next_expiration_points": 970
    },
    "type": "LOYALTY_CARD",
    "campaign": "Loyalty program",
    "campaign_id": "camp_s2Ui43Pk2JMuON3hA7CfwGpa",
    "is_referral_code": false,
    "holder_id": "cust_FGtYypgEx2tBL5jB6PuYfSES",
    "category_id": null,
    "active": true,
    "created_at": "2024-07-09T07:23:14.897Z",
    "updated_at": "2024-07-09T08:36:55.237Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 3,
      "redeemed_points": 30
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "points": 10,
  "campaign": {
    "id": "camp_s2Ui43Pk2JMuON3hA7CfwGpa",
    "name": "Loyalty program",
    "campaign_type": "LOYALTY_PROGRAM",
    "type": "AUTO_UPDATE",
    "voucher": {
      "type": "LOYALTY_CARD",
      "loyalty_card": {
        "points": 0
      },
      "redemption": {
        "quantity": null
      },
      "code_config": {
        "length": 8,
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "########"
      }
    },
    "auto_join": false,
    "join_once": true,
    "active": true,
    "category_id": null,
    "categories": [],
    "metadata": {},
    "created_at": "2024-07-09T07:22:16.139Z",
    "updated_at": "2024-07-09T07:39:39.707Z",
    "object": "campaign"
  },
  "customer": {
    "id": "cust_FGtYypgEx2tBL5jB6PuYfSES",
    "name": "Łukasz",
    "email": "lukasz.kulig@voucherify.io",
    "source_id": "charlie",
    "metadata": {
      "isTrade": true
    },
    "object": "customer"
  },
  "buckets": [
    {
      "id": "lopb_m3gpvB4WLF1a443feIDm2q9i",
      "voucher_id": "v_66qyRgwumJomTSV2NvkCBa05lP0UOn82",
      "campaign_id": "camp_s2Ui43Pk2JMuON3hA7CfwGpa",
      "bucket": {
        "total_points": 10
      },
      "status": "ACTIVE",
      "expires_at": "2024-07-08",
      "created_at": "2024-07-09T08:30:25.671Z",
      "object": "loyalty_points_bucket"
    }
  ],
  "transaction": {
    "id": "vtx_0f0764c45fd232ef8e",
    "source_id": null,
    "voucher_id": "v_66qyRgwumJomTSV2NvkCBa05lP0UOn82",
    "campaign_id": "camp_s2Ui43Pk2JMuON3hA7CfwGpa",
    "source": "Automation",
    "reason": null,
    "type": "POINTS_EXPIRATION",
    "details": {
      "balance": {
        "type": "loyalty_card",
        "total": 1000,
        "object": "balance",
        "points": -10,
        "balance": 970,
        "related_object": {
          "id": "v_66qyRgwumJomTSV2NvkCBa05lP0UOn82",
          "type": "voucher"
        }
      }
    },
    "related_transaction_id": null,
    "created_at": "2024-07-09T08:36:55.237Z"
  }
}
The EVENTS.VOUCHER.LOYALTY_CARD.POINTS_EXPIRED event indicates that loyalty points have expired on a loyalty card. It informs about the loyalty points that were removed under the expiration rules set in the loyalty campaign. This event is used in a webhook configured in Project settings 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 voucher.loyalty_card.points_expired.

voucher
object
required

Simplified voucher data.

points
integer
required

Indicates the number of points that expired.

campaign
object
required

Simplified campaign data.

customer
object
required

Simplified customer data.

buckets
object
required

Contains the details about expiring loyalty points.

transaction
object
required

Transaction details of the voucher.

Response

Webhook accepted

I