Recipient

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/uptimemonitoring-com/json-schema/uptimemonitoring-com-recipient-schema.json",
  "title": "Recipient",
  "description": "Account-level, named delivery target (issue #212) assignable to any\nnumber of monitors via `PUT /api/v1/monitors/{monitorID}/recipients`.\n`secret` is included ONLY on the `POST /api/v1/recipients` response\nfor `type=webhook` — never on `GET`/`PATCH`, and never for\n`type=email`, `type=slack`, or `type=pagerduty`. The signed JSON\ndelivery body for `webhook` is unchanged from the pre-#212\n`Webhook` contract; see its description. `type=email` (issue #321)\nsends outage/recovery alert mail instead of a signed POST — see\n`status` below for its confirmation lifecycle. `type=slack` (issue\n#359) posts an unsigned Block Kit message to a Slack incoming\nwebhook URL; `config.url` is always masked (the real token is\nnever echoed). `type=pagerduty` (issue #363) posts to the\nPagerDuty Events API v2; `config.integration_key` is always masked\n(the real key is never echoed).\n",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/uptimemonitoring-com-openapi.yaml#/components/schemas/Recipient",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "type": {
      "type": "string",
      "enum": [
        "webhook",
        "email",
        "slack",
        "pagerduty"
      ]
    },
    "config": {
      "type": "object",
      "description": "Channel-specific config: `url` for `type=webhook` or\n`type=slack`, `address` for `type=email`, `integration_key`\nfor `type=pagerduty`, plus an optional `channel` for\n`type=slack`. For `type=slack`, `url` is always the masked\nform `https://hooks.slack.com/services/{team}/{bot}/********`\n(or the bare `https://hooks.slack.com/services/********` for a\nstored URL that doesn't match the expected shape) — the real\ntoken is never returned. For `type=pagerduty`,\n`integration_key` is always the masked form `\"********\"` plus\nthe last 4 characters (or the bare `\"********\"` for a stored\nkey that doesn't match the expected shape) — the real key is\nnever returned.\n",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "maxLength": 2048
        },
        "address": {
          "type": "string",
          "format": "email",
          "description": "Normalized (lowercased) email address."
        },
        "channel": {
          "type": "string",
          "description": "`type=slack` only. Optional channel/user override (e.g.\n`\"#ops\"` or `\"@alice\"`); omitted when unset.\n"
        },
        "integration_key": {
          "type": "string",
          "description": "`type=pagerduty` only. Masked — see this object's own\ndescription above.\n"
        }
      }
    },
    "default": {
      "type": "boolean",
      "description": "When true, this recipient is attached automatically to every\nnew monitor created on this account, at create time, in the\nsame transaction as the monitor row. A monitor whose\ncreate-time check finds it down alerts a newly attached\ndefault recipient right away, under the same rules as any\nlater down transition (`down_delay_s`, maintenance windows).\nA monitor created disabled alerts on its first check after it\nis enabled.\n"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "pending",
        "disabled"
      ],
      "description": "`pending`: a `type=email` recipient awaiting confirmation (no\nalerts sent yet). `disabled`: unsubscribed (via the mailed\nunsubscribe link) — alerts stopped; re-enabling requires\ndeleting and recreating the recipient, which re-confirms from\nscratch. `active`: every `type=webhook`, `type=slack`, and\n`type=pagerduty` recipient, and a confirmed, non-disabled\n`type=email` recipient.\n"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "down",
          "up",
          "flapping"
        ]
      },
      "minItems": 1,
      "description": "Non-empty subset of event types this recipient is notified for."
    },
    "monitor_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "Monitors this recipient is currently attached to. `[]` for none."
    },
    "secret": {
      "type": "string",
      "description": "HMAC-SHA256 signing secret, prefix `whs_live_`. Present ONLY on\nthe `POST /api/v1/recipients` response for `type=webhook` (and\nthe deprecated `GET /api/v1/monitors/{monitorID}/webhook`\nalias, for compatibility) — omitted everywhere else, and\nalways omitted for `type=email`, `type=slack`, and\n`type=pagerduty` (neither a slack nor a pagerduty recipient\nhas a secret at all — the incoming webhook URL or the routing\nkey itself is the credential, and both live in `config`,\nmasked).\n"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}