Publication succeeded

post https://example.com/EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED

EVENT: "EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED"
HTTP method: POST

The EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED event indicates that a voucher code was successfully published to a customer.

This event serves as a real-time notification mechanism and it can notify other systems or applications that a voucher was assigned. As a result, the systems can react by, for example, sending a notification about an assignment to a customer.

This event is used in a webhook configured in Distributions in Voucherify dashboard.

📘
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: customer.publication.succeeded

{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "campaign": {
    "id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "name": "Spring Discounts",
    "campaign_type": "DISCOUNT_COUPONS",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "units": null,
        "effect": "APPLY_TO_ORDER",
        "percent_off": 10,
        "amount_limit": 3000,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 3,
        "prefix": "SPRING-2024-",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "###",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": false,
    "active": true,
    "category_id": "cat_0e156dab8f2e43873a",
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": "Spring 2024 big campaign",
    "created_at": "2024-02-21T10:01:24.102Z",
    "updated_at": "2024-02-23T11:43:11.539Z",
    "object": "campaign"
  },
  "publication": {
    "id": "pub_DpHmhx5uTanbM0mnndFrODi1U3MEX6rF",
    "object": "publication",
    "result": "SUCCESS",
    "channel": "voucherify-web-ui",
    "voucher": {
      "id": "v_Zmqfq7rKLPtSHv3aCGrD4863sIoQc4QO",
      "code": "SPRING-2024-tPz",
      "gift": null,
      "type": "DISCOUNT_VOUCHER",
      "active": true,
      "assets": {
        "qr": {
          "id": "2658df7c-5943-477e-87f5-7e582a3e8913",
          "url": "{{voucher_qr_code.url}}"
        },
        "barcode": {
          "id": "2833ddba-5319-487d-9b0b-ec35a287a766",
          "url": "{{voucher_barcode.url}}"
        }
      },
      "object": "voucher",
      "publish": {
        "url": "/v1/vouchers/SPRING-2024-tPz/publications?page=1&limit=10",
        "count": 1,
        "object": "list"
      },
      "campaign": "Spring Discounts",
      "category": "Star Platinum",
      "discount": {
        "type": "PERCENT",
        "effect": "APPLY_TO_ORDER",
        "percent_off": 10,
        "amount_limit": 3000,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "metadata": {},
      "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "categories": [
        {
          "id": "cat_0e156dab8f2e43873a",
          "name": "Star Platinum",
          "object": "category",
          "hierarchy": 10,
          "created_at": "2024-01-03T10:03:24.092Z"
        }
      ],
      "created_at": "2024-03-13T13:45:41.161Z",
      "redemption": {
        "url": "/v1/vouchers/SPRING-2024-tPz/redemptions?page=1&limit=10",
        "object": "list",
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "start_date": null,
      "updated_at": "2024-03-13T13:45:59.498Z",
      "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
      "category_id": "cat_0e156dab8f2e43873a",
      "loyalty_card": null,
      "validity_hours": null,
      "additional_info": null,
      "expiration_date": null,
      "is_referral_code": false,
      "validity_timeframe": null,
      "validity_day_of_week": null
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "name": "Jack Webhook",
      "object": "customer",
      "address": null,
      "loyalty": null,
      "summary": null,
      "metadata": {
        "region": "EMEA",
        "sign-up": "true"
      },
      "referrals": null,
      "source_id": "jck-wbhk"
    },
    "metadata": {},
    "source_id": null,
    "created_at": "2024-03-13T13:45:59.492Z",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "jck-wbhk",
    "vouchers_id": [
      "v_Zmqfq7rKLPtSHv3aCGrD4863sIoQc4QO"
    ]
  },
  "voucher": {
    "id": "v_Zmqfq7rKLPtSHv3aCGrD4863sIoQc4QO",
    "code": "SPRING-2024-tPz",
    "discount": {
      "type": "PERCENT",
      "amount_limit": 3000,
      "percent_off": 10,
      "effect": "APPLY_TO_ORDER",
      "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
    },
    "type": "DISCOUNT_VOUCHER",
    "campaign": "Spring Discounts",
    "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": "cat_0e156dab8f2e43873a",
    "active": true,
    "created_at": "2024-03-13T13:45:41.161Z",
    "updated_at": "2024-03-13T13:45:59.498Z",
    "redemption": {
      "quantity": 1,
      "redeemed_quantity": 0
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  }
}

Response

Response body

object

customer

object | null

required

Simplified customer data.

string

Unique identifier of an existing customer. It is assigned by Voucherify.

name

string

Customer's first and last name.

string

Customer's email address.

source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

Has additional fields

object

string

The type of the object represented by JSON.

customer

campaign

object | null

required

Simplified campaign data.

string

Campaign ID.

name

string

Campaign name.

campaign_type

string

Type of campaign.

type

string

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
STATIC: vouchers need to be manually published
STANDALONE: campaign for single vouchers

AUTO_UPDATE STATIC STANDALONE

is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

voucher

object

Simplified campaign voucher data.

referral_program

object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

auto_join

boolean

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

join_once

boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them.

active

boolean

Indicates whether the campaign is active.

category_id

string | null

The unique category ID that this campaign belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

object

string

required

Defaults to category

The type of the object represented by the JSON. This object stores information about the category.

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

metadata

object

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

Has additional fields

start_date

date-time

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

expiration_date

date-time

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

description

string

An optional field to keep extra textual information about the campaign such as a campaign description and details.

created_at

date-time

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.

object

string

Defaults to campaign

The type of the object represented by JSON. This object stores information about the campaign.

campaign

publication

object | null

required

Publication with a voucher.

string

required

Unique identifier of the publication assigned by Voucherify.

object

string

required

Defaults to publication

The type of the object represented by the JSON. This object stores information about the publication.

publication

created_at

date-time

required

Timestamp representing the date and time when the publication was created in the ISO 8601 format.

customer_id

string

required

Unique identifier of the customer receiving the publication.

tracking_id

string

Customer's source_id.

metadata

object

required

The metadata object stores all custom attributes assigned to the publication.

channel

string

required

How the publication was originated.

source_id

string | null

required

Unique identifier of the merchant's publication if it is different from the Voucherify publication ID.

result

string

Defaults to SUCCESS

Status of the publication attempt.

SUCCESS

customer

object

required

Customer details with details about loyalty and referral programs.

vouchers_id

array of strings

required

Contains the unique internal voucher ID that was assigned by Voucherify.

vouchers_id*

voucher

object

required

Defines the voucher reward.

voucher

object

required

Simplified voucher data.

string

A unique identifier that represents the voucher assigned by Voucherify.

code

string

required

Voucher code.

gift

object

Contains current gift card balance information.

discount

object

Contains information about discount.

loyalty_card

object

Simplified loyalty card data.

type

string

required

Type of the voucher.

DISCOUNT_VOUCHER LOYALTY_CARD GIFT_VOUCHER

campaign

string

Campaign name.

campaign_id

string

Campaign unique ID.

is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

holder_id

string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

category_id

string | null

Unique identifier of the category that this voucher belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

object

string

required

Defaults to category

The type of the object represented by the JSON. This object stores information about the category.

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

created_at

date-time

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

updated_at

date-time

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

redemption

object

Defines the redemption limits on vouchers.

start_date

date-time

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

expiration_date

date-time

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

Has additional fields

object

string

required

Defaults to voucher

The type of the object represented by JSON.

voucher

EVENT: "EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED"HTTP method: POST

📘Webhook documentation

Example: customer.publication.succeeded

200Indicates that a voucher has been published successfully to a customer.

EVENT: "EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED"
HTTP method: POST

📘
Webhook documentation