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

Triggers let you receive notifications when your data in Honeycomb crosses the thresholds that you configure.The graph on which to alert is as flexible as a Honeycomb query, which helps reduce false positives due to known errors.Triggers support both standard event-based datasets and metrics datasets. Metrics triggers have additional capabilitiessuch as granularity control.Learn more in the [Triggers documentation](https://docs.honeycomb.io/notify/alert/triggers/).This API allows you to list, create, update, and delete Triggers.## AuthorizationThe API key must have the **Manage Triggers** permission. Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).

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

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

This API exposes 6 operations across 3 paths, and defines 13 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.

6 operations 3 paths 13 schemas 1 DELETE3 GET1 POST1 PUT

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 6

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

Triggers 6

Triggers let you receive notifications when your data in Honeycomb crosses the thresholds that you configure. The graph on which to alert is as flexible as a Honeycomb query, whic…

GET
/1/triggers/{datasetSlug}
List All Triggers
listTriggers 1 param → 200401403404429default
POST
/1/triggers/{datasetSlug}
Create a Trigger
createTrigger 1 param body → 201400401403404413422429
GET
/1/triggers/{datasetSlug}/{triggerId}
Get a Trigger
getTrigger 2 params → 200401403404429
PUT
/1/triggers/{datasetSlug}/{triggerId}
Update a Trigger
updateTrigger 2 params body → 200400401403404422429
DELETE
/1/triggers/{datasetSlug}/{triggerId}
Delete a Trigger
deleteTrigger 2 params → 204401404429
GET
/1/recipients/{recipientId}/triggers
Get Triggers Associated with a Recipient
listTriggersWithRecipient 1 param → 200401404429default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BaseTrigger (17 properties), DetailedError (6 properties), NotificationRecipient (4 properties), Tag (2 properties). Each schema is shown below with its type and property counts.

BaseTrigger
object
17 properties
Tag
object
2 properties 2 required
RecipientType
string
One of the supported Recipient Types
TriggerResponse
TriggerWithInlineQuery
Error
object
A legacy error, containing only a textual description.
1 property
CreateTriggerRequest
ValidationError
NotificationRecipientDetails
object
2 properties
TriggerWithQueryReference
NotificationRecipient
object
4 properties
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
JSONAPIError
object
A JSONAPI-formatted error message.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-triggers-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 Events API
Honeycomb Key Management API
Honeycomb Kinesis Events API
Honeycomb Marker Settings API