HOhoneycomb
Anomaly Detection

Assign Recipients in Bulk

Changed on

Use this endpoint to bulk add Recipients to many Signals in one call, rather than updating each Signal individually.

Requires the Manage Recipients permission in addition to Manage Signals.

post/1/signals/recipient_assignments

Request

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

Request body

Example request

{
  "selector": {
    "signal_ids": [
      "hcaip_01jak3ymk8s5cpc2xz3q7d8v9r"
    ]
  },
  "recipients": [
    {
      "id": "hcar_01jak3ymk8s5cpc2xz3q7d8v9r",
      "details": {
        "pagerduty_severity": "critical"
      }
    }
  ]
}

Response

The batch was processed. Every requested Signal appears in exactly one of succeeded, unchanged, or failed.

succeededstring[] required

The Signals whose Recipient set was updated.

unchangedstring[] required

The Signals that already had every requested Recipient.

Example response

{
  "succeeded": [
    "hcaip_01jak3ymk8s5cpc2xz3q7d8v9r"
  ],
  "unchanged": [
    "hcaip_01jak3ymk8s5cpc2xz3q7d8v9r"
  ],
  "failed": [
    {
      "signal_id": "hcaip_01jak3ymk8s5cpc2xz3q7d8v9r",
      "detail": "Signal not found"
    }
  ]
}

Changes