Reference
Events API
Events API
Event logging and retrieval
Event Structure
All events follow the SynapEvent schema:
Log Event
User-Created Event
AI-Created Event (with metadata)
List Events
Filter by AI-Created
Get Event
Returns:
Metadata Types
Events can carry optional metadata for context:
| Type | Purpose | Example |
|---|---|---|
ai | AI enrichment | Agent, confidence, extraction source |
import | Import context | Source system, external ID |
sync | Device sync | Device ID, platform, offline |
automation | Rule triggers | Rule ID, execution context |
custom | Extensions | Your own metadata |
See Event sourcing explained for how events are modeled end to end.
Next: See Integration fundamentals for Hub Protocol entry points.
