Honeycomb Recipients API
Honeycomb Recipients allow you to define and manage the Recipients that will get notified by a Trigger or Burn Alert.The types of Recipients supported are: PagerDuty, Email, Webhook, Microsoft Teams, and Slack.## AuthorizationThe API key must have the **Manage Recipients** permission. Recipients are team-wide and NOT environment-specific.API Keys with the **Manage Recipients** permission can modify recipients used by ALL environments for a given team.Learn more about [API keys here](https://docs.honeycomb.io/configure/environments/manage-api-keys/).
Honeycomb Recipients API is one of 21 APIs that Honeycomb publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Recipients. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 16 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.
Metadata
The identity and technical contract details declared by the specification.
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.
Honeycomb Recipients allow you to define and manage the Recipients that will get notified by a Trigger or Burn Alert. The types of Recipients supported are: PagerDuty, Email, Webh…
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are DetailedError (6 properties), RecipientProperties (4 properties), WebhookHeader (2 properties), TemplateVariableDefinition (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Honeycomb 12
Other APIs Honeycomb publishes across the network.