Skip to main content
POST
/
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
}

Response

200 - application/json

Indicates that a customer-related custom event has occurred.

Event data object schema for customer.custom_event.

​
event
object
required

Details about the custom event.

​
event_schema
object
required

Simplified custom event data.

​
customer
object
required

Simplified customer data.

​
referral
object | null
required

Details about the referral.

​
loyalty
object | null
required

Details about the loyalty activity.

​
campaign
object

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

​
voucher
object

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

​
publication
object

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

​
promotion_tier
object

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

⌘I