Ingest

Ingest Business Event

Accepts event-shaped business data using a hashed sx_ingest_* key. kpi.snapshot events also attempt the KPI snapshot fast path.

post/ingest/events

Request

  • Base URL: https://synchronex.ai/api/v1
  • URL: https://synchronex.ai/api/v1/ingest/events
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://synchronex.ai/oauth/authorize, token URL https://synchronex.ai/api/oauth/token, scopes: read)

Request body

event_typestring required
severity'info' | 'warning' | 'error' | 'critical'
external_idstring
idempotency_keystring
occurred_atstring date-time
worker_typestring
payloadobject

Response

Event ingested.

successboolean required
event_idstring uuid nullable
dataset_idstring uuid
insertedinteger
deduplicatedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.