Event Ingestion API¶
Observability receives, aggregates, and displays event information sent by your tools and data assets (i.e. components). The system does so by exposing a REST API—the Event Ingestion API—where the events are received and ingested in real time.
The Event Ingestion API is a set of POST-only endpoints that receive events from your data estate; check that events are sent with an API key and that the data schema of each event is valid; and forward the events to the system.
Note
All methods to integrate your data estate with Observability use the Event Ingestion API.
For an overview of each integration method, see Integrate your Tools.
API keys¶
The integration agents or external scripts that send events from your data estate to Observability are required to provide an API key to authenticate with the Event Ingestion API. API keys are managed at the project level and allow the system to associate events with the correct project.
You can create and manage API keys from the API Keys page. For steps on how to, see API Keys.
Understand Event Ingestion API identifiers¶
The Event Ingestion API requires specific properties for each event. To learn more about what these values represent, see Event Ingestion API Identifiers.
API documentation¶
You can find technical details about the Event Ingestion API endpoints in the Swagger documentation .
Event payload limit¶
There is a payload size limit of 100 KB for events. This limit is validated at the API level.
Note, the Test Outcomes event has a 500 item limit per event.