Vouchers Generation Completed

WEBHOOK EVENTS.CAMPAIGN.VOUCHERS.GENERATION.COMPLETED

campaign.created

{
  "count": 5,
  "campaign": {
    "id": "camp_18NCNUkQIaXnqbHqhtQnt355",
    "name": "Test-campaign-applicable-to",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": null,
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "units": null,
        "effect": "APPLY_TO_ITEMS",
        "percent_off": 5,
        "amount_limit": 15000,
        "aggregated_amount_limit": 30000
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 1,
        "prefix": "Test-applicable-",
        "charset": "0123456789",
        "pattern": "#",
        "postfix": ""
      },
      "loyalty_card": null
    },
    "metadata": {},
    "auto_join": false,
    "join_once": false,
    "created_at": "2024-02-09T10:16:04.352Z",
    "category_id": null,
    "campaign_type": "DISCOUNT_COUPONS",
    "is_referral_code": false
  },
  "completed_at": "2024-02-09T10:16:04.787Z"
}

The EVENTS.CAMPAIGN.VOUCHERS.GENERATION.COMPLETED event indicates that voucher generation for a given campaign was completed. It includes details about the campaign for which voucher were generated, the number of generated vouchers, and the date when the process was completed.

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 campaign.vouchers.generation.completed.

campaign · Simple Campaign · object

Simplified campaign data.

Show child attributes

count · integer

Number of generated vouchers.

completed_at · string<date-time>

Timestamp representing the date and time when the generation of the campaign vouchers was completed in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

Response

200

Webhook accepted