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, and Slack.
The 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.
The Recipient will be created for the Team associated with your API key.
The body of the POST should be a JSON encoded object containing key/value pairs. Id cannot not be set during creation.
Before Slack recipients can be created, the Slack OAuth flow in the Integration Center must be completed.
Success
Unauthorized
Conflict
Validation Failed
{- "type": "pagerduty",
- "details": {
- "pagerduty_integration_name": "Example PagerDuty Service",
- "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
}
}
{- "id": "yUheCUmgZ8p",
- "created_at": "2022-07-26T22:38:04Z",
- "updated_at": "2022-07-26T22:38:04Z",
- "type": "pagerduty",
- "details": {
- "pagerduty_integration_name": "Example PagerDuty Service",
- "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
}
}
Retrieve all recipients for a team.
Success
Unauthorized
[- {
- "id": "yUheCUmgZ8p",
- "created_at": "2022-07-26T22:38:04Z",
- "updated_at": "2022-07-26T22:38:04Z",
- "type": "pagerduty"
}
]
Retrieve a Recipient by recipient ID.
Success
Unauthorized
Not Found
{- "id": "yUheCUmgZ8p",
- "created_at": "2022-07-26T22:38:04Z",
- "updated_at": "2022-07-26T22:38:04Z",
- "type": "pagerduty",
- "details": {
- "pagerduty_integration_name": "Example PagerDuty Service",
- "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
}
}
Update a Recipient by specifying the recipient ID and full recipient details. (Partial PUT is not supported.)
Updates to the Recipient Type is not supported. For example, changing an existing Recipient from PagerDuty to Email is not allowed.
Important: Modifying an existing recipient will change the destination of all triggers/burn alerts that use that recipient.
Success
Unauthorized
Not Found
Conflict
Validation Failed
{- "type": "pagerduty",
- "details": {
- "pagerduty_integration_name": "Example PagerDuty Service",
- "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
}
}
{- "id": "yUheCUmgZ8p",
- "created_at": "2022-07-26T22:38:04Z",
- "updated_at": "2022-07-26T22:38:04Z",
- "type": "pagerduty",
- "details": {
- "pagerduty_integration_name": "Example PagerDuty Service",
- "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
}
}
Delete a recipient by specifying the recipient ID.
A Recipient can only be deleted if it is NOT in use by any Triggers or Burn Alerts associated to the team.
Success - no content
Unauthorized
Not Found
Conflict
{- "error": "unknown API key - check your credentials"
}