Kinesis Events

The Kinesis Events API endpoints allow Honeycomb to process streaming events from Amazon Kinesis.

Refer to the Honeycomb AWS integrations documentation for more information.

Authorization

It 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.

Create Kinesis Events

This endpoint processes events and metrics coming from AWS through Kinesis Firehose.

Securityfirehose_access_key
Request
path Parameters
datasetSlug
required
string

The dataset slug.

header Parameters
X-Amz-Firehose-Request-Id
required
string

AWS Request ID associated with the Kinesis Firehose.

Example: 33658b45-a8f1-4007-92e8-f601ae33db14
Request Body schema: application/json
required

The request body expected from Amazon Kinesis Firehose. Events and metrics have the same shape but the base64 encoded data blob for metrics is expected to be Protowire-encoded as well. CloudWatch Logs data coming through Amazon Kinesis Firehose is expected to have a gzip Content-Encoding.

requestId
string
timestamp
integer
Array of objects (KinesisEventRecord)
Responses
200

Events queued for processing

401

Unauthorized

default

Error

post/1/kinesis_events/{datasetSlug}
Request samples
application/json
{
  • "requestId": "string",
  • "timestamp": 0,
  • "records": [
    ]
}
Response samples
application/json
{
  • "requestId": "string",
  • "timestamp": 0,
  • "errorMessage": "string"
}