v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB
Events

Track Event

Record a customer event for a project. Requires the audience:write permission. Contact resolution is consent safe: profile fields may update, subscription status never changes. Send an Idempotency-Key header (or a body dedupeKey) for replay safety; without either, every call stores a distinct event. Events carrying identifiers.externalOrderId and a numeric properties.value are recorded as conversions attributed to the last email the contact clicked within five days.

post/v1/events

Headers

Idempotency-Keystring

Replay-safe key. Takes precedence over the body dedupeKey.

Request body

projectIdstring required
namestring required

Event name, e.g. purchase.completed. Names containing refund or cancelled record negative conversion amounts.

originstring
eventVersionstring
propertiesobject

Event facts. Up to 16KB, 50 top-level keys, 4 levels deep. A numeric value (major units, e.g. 49.99) together with identifiers.externalOrderId records a conversion; currency is an ISO code, default USD.

occurredAtstring date-time

When the event happened. Defaults to receipt time.

dedupeKeystring

Event-identity dedupe key. Replaying the same key stores nothing and returns the original eventId.

Response

Event stored (or replayed)

successboolean required
errorstring nullable