This endpoint is separate from the batch Events API. Use this for real-time, single-event ingestion from mobile apps, websites, and backend services.
Base Path
POST /api/v1/events/ingest
Ingest a single customer event for real-time processing. Roles: Any authenticated user (no role check — only requires valid tenant).Request Body
Event Types
Each event type is mapped to one or more internal trigger event types. This means a single
purchase event can fire both purchase-specific triggers and broader outcome.recorded triggers.Response 200
Response Fields
Example
Processing Pipeline
When an event is ingested, the following happens in order:- Validation — The request body is validated against the Zod schema. Invalid events return a
400. - Event stream publish — The event is published to the internal event bus. If the stream is unavailable, processing continues (non-critical).
- Trigger evaluation — Active trigger rules are loaded and evaluated against the event. Each matching trigger’s action is dispatched.
- Response — The API returns the ingestion result with matched triggers and dispatched actions.
Cross-Channel Triggers
Event ingestion powers cross-channel workflows. For example:Error Codes
See Also
- Events API — Batch event ingestion
- Triggers — Configure trigger rules
- Geofence Check — Location-based event triggers