v3

OpenAPI 3.1.02026-07-2759128137.8 KB
events

Ingest Event

Ingest a first-party event.

Every well-formed event is accepted and stored, whether or not its subject can be correlated to a known contact or company: correlation is best-effort and runs asynchronously. Replaying the same external_event_id (or the exact same event content) is idempotent: the event is accepted but never stored or processed twice.

Requires the events:write scope on the API key.

post/v1/events

Request body

eventNamestring required
occurredAtstring date-time required
externalEventIdstring nullable
payloadobject nullable

Response

Successful Response

acceptedboolean required
idempotencyKeystring required