EVENT: "EVENTS.CUSTOMER.CUSTOM_EVENT"
HTTP method: POST

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.

📘

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.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
}