Skip to main content
WEBHOOK
EVENTS.CUSTOMER.CUSTOM_EVENT
{
  "event": {
    "id": "event_0e70ee5acd8b2555ce",
    "object": "event",
    "type": "sign_up",
    "customer": {
      "id": "cust_154FDQKcbzygdo231M62r4CD"
    },
    "referral": null,
    "loyalty": null,
    "metadata": {
      "source": "API"
    },
    "created_at": "2024-03-14T11:47:24.598Z"
  },
  "event_schema": {
    "id": "ms_f1r5Tcu5T0m3v3nT5ch3ma",
    "name": "sign_up"
  },
  "customer": {
    "id": "cust_154FDQKcbzygdo231M62r4CD",
    "name": "Alex Doe",
    "email": null,
    "source_id": "4lx-d03",
    "metadata": {
      "region": "EMEA"
    },
    "object": "customer"
  },
  "referral": null,
  "loyalty": null
}
The EVENTS.CUSTOMER.CUSTOM_EVENT event indicates that a custom event has occurred and it involved a customer. When the event is used in an “Custom event” distribution webhook, the data object always contains the following required objects:
  • event,
  • event_schema,
  • customer,
  • referral,
  • loyalty.
Additional objects are also sent depending on the purpose:
  • “Notify customers about promotion” sends also the following objects:
    • campaign,
    • promotion_tier,
  • “Send and publish unique codes from campaign” sends also the following objects:
    • campaign,
    • voucher,
    • publication,
  • “Send plain message to customers” sends only the basic objects listed above.
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.custom_event.

​
event
Custom Event · object
required

Details about the custom event.

​
event_schema
Simple Custom Event · object
required

Simplified custom event data.

​
customer
Simple Customer · object
required

Simplified customer data.

​
referral
object
required

Details about the referral.

​
loyalty
object
required

Details about the loyalty activity.

​
campaign
Simple Campaign · object

Details about the campaign related to the distribution with a promotion or send voucher purpose.

​
voucher
Simple Voucher · object

Details about the voucher related to the distribution with a send voucher purpose.

​
publication
Publications Item Base · object

Details about the publication related to the distribution with a send voucher purpose.

​
promotion_tier
Simple Promotion Tier · object

Details about the promotion tier related to the distribution with a promotion purpose.

Response

Webhook accepted

Last modified on November 25, 2025