Skip to main content
POST
Ingest Event

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Body

application/json

Ingest Event payload

event_name
string
required

Custom event name (1–255 characters).

Required string length: 1 - 255
occurred_at
string<date-time>
required

RFC 3339 timestamp when the event occurred.

subject
PublicEventSubjectInput · object
required

Event subject identifiers; at least one field is required.

external_event_id
string | null

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

Maximum string length: 255
payload
Payload · object | null

Free-form JSON attributes for the event.

Response

202 - application/json

Successful Response

accepted
boolean
required

Whether the event was accepted for processing.

idempotency_key
string
required

Key under which the event was deduplicated.