HOhoneycomb
Recipients

Update a Recipient

Changed on

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.

put/1/recipients/{recipientId}

Request

  • Base URL
    https://api.honeycomb.io
  • URL
    https://api.honeycomb.io/1/recipients/{recipientId}
  • 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

  • 276c5555582aRevision 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