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

event_namestring required

Custom event name (1–255 characters).

occurred_atstring date-time required

RFC 3339 timestamp when the event occurred.

external_event_idstring nullable

Optional stable identifier from the caller's system, used for idempotent replays.

payloadobject nullable

Free-form JSON attributes for the event.

Response

Successful Response

acceptedboolean required

Whether the event was accepted for processing.

idempotency_keystring required

Key under which the event was deduplicated.

Changes

Changed in 1 of the 12 revisions of this API.376

Aug 4, 2026467ce2bf692b376See the full diff
- ▲
  added the new required request property event_name
  new-required-request-property
- ▲
  added the new required request property occurred_at
  new-required-request-property
- ▲
  removed the required property idempotencyKey from the response with the 202 status
  response-required-property-removed
- ●
  removed the request property eventName
  request-property-removed
- ●
  removed the request property externalEventId
  request-property-removed
- ●
  removed the request property occurredAt
  request-property-removed
- ●
  removed the request property subject/companyDomain
  request-property-removed
- ●
  removed the request property subject/externalCompanyId
  request-property-removed
- ●
  removed the request property subject/externalContactId
  request-property-removed
- ●
  removed the request property subject/linkedinUrl
  request-property-removed
- ○
  added the new optional request property external_event_id
  new-optional-request-property
- ○
  added the new optional request property subject/company_domain
  new-optional-request-property
- ○
  added the new optional request property subject/external_company_id
  new-optional-request-property
- ○
  added the new optional request property subject/external_contact_id
  new-optional-request-property
- ○
  added the new optional request property subject/linkedin_url
  new-optional-request-property
- ○
  added the required property idempotency_key to the response with the 202 status
  response-required-property-added

Full history