Get event schemas
Returns the published payload of a built-in event - a real example payload per provider, plus every property path with its type, the merge tag that resolves it, and a description wherever the example alone is ambiguous (a null sample, an empty list, a unit that is not obvious, or a type that differs per provider). Omit eventName to list every documented event. Static reference data describing the shape of an event, not what the account has received. An event with no published payload returns documented false; it is still valid to trigger and to build a sequence on, because custom events carry exactly the properties you send.
Query parameters
Event to describe, such as ecommerce.order_placed. Legacy aliases like order.completed resolve to their current name. Omit to list every documented event.
Return only this provider's payload: shopify, woocommerce, manual, api, or stripe.
Response
Event schemas returned
Example response
{
"success": true,
"eventName": "ecommerce.order_placed",
"events": [
{
"eventName": "ecommerce.order_placed",
"mergeTagPrefix": "event."
}
]
}