How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 22 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.2.0, at version 1.0.0.

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

5 operations 2 paths 16 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

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.

Recipients 5

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…

POST
/1/recipients
Create a Recipient
createRecipient body → 201400401403409422
GET
/1/recipients
List all Recipients
listRecipients → 200401
GET
/1/recipients/{recipientId}
Get a single Recipient
getRecipient 1 param → 200401404
PUT
/1/recipients/{recipientId}
Update a Recipient
updateRecipient 1 param body → 200401404409422
DELETE
/1/recipients/{recipientId}
Delete a Recipient
deleteRecipient 1 param → 204401404409

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), TemplateVariableDefinition (2 properties), WebhookHeader (2 properties). Each schema is shown below with its type and property counts.

Error
object
A legacy error, containing only a textual description.
1 property
MSTeamsRecipient
JSONAPIError
object
A JSONAPI-formatted error message.
1 property
Recipient
object
1 property 1 required
PayloadTemplate
object
1 property
DetailedError
object
An RFC7807 'Problem Detail' formatted error message.
6 properties 4 required
ValidationError
SlackRecipient
EmailRecipient
RecipientType
string
One of the supported Recipient Types
TemplateVariableDefinition
object
2 properties 1 required
WebhookHeader
object
2 properties 1 required
WebhookRecipient
PagerDutyRecipient
MSTeamsWorkflowRecipient
RecipientProperties
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

honeycomb-io-recipients-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
Where this information came from

This is an independent, third-party profile of Honeycomb Recipients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.