Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Honeycomb Events API

The Events API endpoints are the lowest-level way to send Events to Honeycomb. **This should be your last resort!**If unsure where to start when instrumenting an application, read about how to [Send Data to Honeycomb](https://docs.honeycomb.io/send-data/).If you are building a tracing or metrics library, we recommend using [OpenTelemetry](https://docs.honeycomb.io/send-data/opentelemetry/).## AuthorizationIt is recommended that an Ingest API key is used for sending events.A Configuration API key will work, and must have the **Send Events** permission.Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

Honeycomb Events API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.honeycomb.io, https://api.eu1.honeycomb.io.

2 operations 2 paths 5 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.honeycomb.io
License
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Events 2

The Events API endpoints are the lowest-level way to send Events to Honeycomb. This should be your last resort! If unsure where to start when instrumenting an application, read ab…

POST
/1/batch/{datasetSlug}
Create Events
createEvents 2 params body → 200400401403404429
POST
/1/events/{datasetSlug}
Create an Event
createEvent 3 params body → 200400401403404429

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are DetailedError (6 properties), BatchEvent (3 properties), Error (1 property), JSONAPIError (1 property). Each schema is shown below with its type and property counts.

BatchEvent
object
3 properties
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
Error
object
A legacy error, containing only a textual description.
1 property
Event
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-events-api-openapi.yml Raw ↑

Other APIs Honeycomb publishes across the network.

Honeycomb Auth API
Honeycomb Boards API
Honeycomb Burn Alerts API
Honeycomb Calculated Fields API
Honeycomb Columns API
Honeycomb Dataset Definitions API
Honeycomb Datasets API
Honeycomb Environments API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API
Honeycomb Markers API