Notifications

Get notification details

The same body as /status on the same notification — one card with the delivery state, the channels tried, the escalation it started, and, once somebody has taken the alert, acknowledged_at and acknowledged_via.

get/api/v1/notifications/{notification}

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/notifications/{notification}
  • Auth: API key in header X-API-Key

Path parameters

notificationstring uuid required

Response

Notification details.

uuidstring uuid
status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | 'acknowledged' | 'escalating'

Lifecycle state of a notification. FOUR of the seven are terminal and will never change again: completed, failed, cancelled, acknowledged. Poll until you see one of those four — waiting only for completed or failed hangs until your own timeout on every alert a human confirms.

pending — created, waiting for a worker. Not terminal. processing — a worker is delivering it right now. Not terminal. escalating — delivery happened, nobody confirmed in time, and the escalation chain is walking to the next person. Not terminal: it still ends in acknowledged or failed. completed — delivered. TERMINAL. failed — every channel and attempt was exhausted without delivery. TERMINAL, and the only status retry accepts. cancelled — stopped before delivery, by the cancel endpoint. TERMINAL. acknowledged — a human confirmed it and the escalation chain stopped. TERMINAL, and the outcome the product exists for: an alert that reaches this has done its job.

priority'low' | 'normal' | 'high' | 'critical'
messagestring

The text as it was sent.

audio_filestring nullable
is_owner_fallbackboolean

True when this notification IS the rescue email to the account owner rather than an alert of yours. The alert it was sent about is named by original_notification_uuid in metadata, and owner_fallback_reason there says why delivery failed.

total_attemptsinteger

Delivery attempts across all channels.

external_idstring nullable

Provider-side identifier of the delivered message or call, when the provider gives one.

error_messagestring nullable

Last delivery error. Present on failed, and possibly on a notification that later succeeded through a fallback.

metadataobject nullable
created_atstring date-time
completed_atstring date-time nullable

Set once the notification reaches a terminal status; null while it is still moving.

acknowledged_atstring date-time nullable

When a human took the alert. Null on anything that was never acknowledged. This is the moment the escalation chain stopped, so acknowledged_at - created_at is the response time of this incident.

acknowledged_viastring nullable

The label recorded with the acknowledgement — the source you sent to the acknowledge endpoint (default api), or the surface the platform acknowledged from on its own: telegram_callback, dtmf, dashboard, email_link, and so on. Null on anything that was never acknowledged. Together with acknowledged_at this is the audit trail the acknowledge endpoint promises; nothing else exposes it.

Changes

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