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 Triggers API

The Honeycomb Triggers API allows developers to programmatically configure alerting rules that fire when query results meet specified conditions. Triggers work in conjunction with the Recipients API, which manages notification destinations including PagerDuty, Email, Webhook, Microsoft Teams, and Slack. The API supports listing, creating, updating, and deleting triggers, enabling automated setup of alerting workflows for production observability.

Honeycomb Triggers API is one of 22 APIs that honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Alerts, Monitoring, Notifications, and Observability. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an AsyncAPI specification.

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

Requests are made against a single base URL, https://api.honeycomb.io.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.honeycomb.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Honeycomb Triggers API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Honeycomb-Team (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Honeycomb Configuration API key. Must have appropriate permissions for the endpoint being called.

Paths & Operations 5

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

Triggers 5

Configure alerting rules that fire when query results meet specified conditions.

GET
/1/triggers/{datasetSlug}
List all triggers
listTriggers 1 param → 200401
POST
/1/triggers/{datasetSlug}
Create a trigger
createTrigger 1 param body → 201401
GET
/1/triggers/{datasetSlug}/{triggerId}
Get a trigger
getTrigger 2 params → 200401404
PUT
/1/triggers/{datasetSlug}/{triggerId}
Update a trigger
updateTrigger 2 params body → 200401404
DELETE
/1/triggers/{datasetSlug}/{triggerId}
Delete a trigger
deleteTrigger 2 params → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Trigger (10 properties), QuerySpec (9 properties), TriggerUpdateRequest (7 properties), TriggerCreateRequest (7 properties). Each schema is shown below with its type and property counts.

RecipientRef
object
1 property
TriggerCreateRequest
object
7 properties 4 required
TriggerUpdateRequest
object
7 properties
Trigger
object
10 properties
QuerySpec
object
A query specification defining what data to retrieve and how to aggregate it.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-triggers-api-openapi.yml Raw ↑

Other APIs honeycomb publishes across the network.

Honeycomb Events API
Honeycomb Queries API
Honeycomb SLOs API
Honeycomb Datasets API
Honeycomb Boards API
Honeycomb Markers API
Honeycomb Environments API
honeycomb Auth API
honeycomb Burn Alerts API
honeycomb Calculated Fields API
honeycomb Columns API
honeycomb Dataset Definitions API