Recipients

Create a Recipient

Changed on

Unlike many resources, Recipients are not linked to a specific Environment or Dataset. The Recipient will be created for the Team associated with your API key. The details fields will vary depending on the type of Recipient. Use the drop-down to view the specific fields for each type value. Before Slack Recipients can be created, the Slack OAuth flow in the Integration Center must be completed.

post/1/recipients

Request

  • Base URL
    https://api.honeycomb.io
  • URL
    https://api.honeycomb.io/1/recipients
  • Auth
    API key in header X-Honeycomb-Team

Request body

OR
OR
OR
OR
OR

Example request

{
  "id": "yUheCUmgZ8p",
  "created_at": "2022-07-26T22:38:04Z",
  "updated_at": "2022-07-26T22:38:04Z",
  "details": {
    "pagerduty_integration_name": "Example PagerDuty Service",
    "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
  }
}

Response

Success

OR
OR
OR
OR
OR

Example response

{
  "id": "yUheCUmgZ8p",
  "created_at": "2022-07-26T22:38:04Z",
  "updated_at": "2022-07-26T22:38:04Z",
  "details": {
    "pagerduty_integration_name": "Example PagerDuty Service",
    "pagerduty_integration_key": "7zOwh1edS8xHGcwfb2bA4sqY8E6PJzSK"
  }
}

Changes

    • info

      added the new optional request property ////////

    • info

      added pagerduty email slack webhook msteams msteams_workflow mapping keys to the request discriminator

    • info

      added pagerduty email slack webhook msteams msteams_workflow mapping keys to the response discriminator for the response status

    • info

      added the optional property //////// to the response with the status