Get a recipient

get/api/v1/recipients/{recipientID}

Request

  • Base URL: https://api.uptimemonitoring.com
  • URL: https://api.uptimemonitoring.com/api/v1/recipients/{recipientID}
  • Auth: HTTP bearer

Response

Recipient (never includes secret)

idinteger
namestring
type'webhook' | 'email' | 'slack' | 'pagerduty'
defaultboolean

When true, this recipient is attached automatically to every new monitor created on this account, at create time, in the same transaction as the monitor row. A monitor born down does NOT notify a newly-attached default recipient at creation — the create response already shows the monitor's state directly, and the default's first notification is the monitor's next qualifying transition.

status'active' | 'pending' | 'disabled'

pending: a type=email recipient awaiting confirmation (no alerts sent yet). disabled: unsubscribed (via the mailed unsubscribe link) — alerts stopped; re-enabling requires deleting and recreating the recipient, which re-confirms from scratch. active: every type=webhook, type=slack, and type=pagerduty recipient, and a confirmed, non-disabled type=email recipient.

eventsstring[]

Non-empty subset of event types this recipient is notified for.

monitor_idsinteger[]

Monitors this recipient is currently attached to. [] for none.

secretstring

HMAC-SHA256 signing secret, prefix whs_live_. Present ONLY on the POST /api/v1/recipients response for type=webhook (and the deprecated GET /api/v1/monitors/{monitorID}/webhook alias, for compatibility) — omitted everywhere else, and always omitted for type=email, type=slack, and type=pagerduty (neither a slack nor a pagerduty recipient has a secret at all — the incoming webhook URL or the routing key itself is the credential, and both live in config, masked).

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.