Sign in

v1

latestOpenAPI 3.1.02026-07-22750642.5 KB
CDP Events

Record event

Record one behavioral event for a person and/or custom object. This is the real-time path — it triggers journey enrollment. Unknown subjects still ingest and are linked later.

post/api/v1/cdp/events

Request body

namestring required

Event name, e.g. "checkout_completed". Letters, numbers, underscores only.

externalIdstring required

Your stable id for this event (idempotency key). Re-recording returns created: false.

timestampstring date-time

When the event occurred, ISO 8601. Defaults to now if omitted.

personExternalIdstring

Subject: the person externalId this event is about.

customObjectTypestring

Subject: the custom-object type name. Must be paired with customObjectExternalId.

customObjectExternalIdstring

Subject: the custom-object externalId. Must be paired with customObjectType.

propertiesobject

Free-form event payload.

Response

Success

createdboolean required

false when the externalId was already recorded (idempotent).

eventIdstring
personIdstring
personExternalIdstring
customObjectTypestring
customObjectExternalIdstring