Raise an alert

Raises an alert for something nothing automatic would have caught - a report from a customer, a figure that looks wrong. It is published through the platform's own alert pipeline rather than written straight to the queue, so everything that processes alerts handles it exactly as it handles one the platform raised: it is deduplicated against recent alerts of the same shape, given an owner from the ownership rota, and forwarded wherever alerts are forwarded. Who raised it is stamped on the alert's creation history entry and repeated in the message, which is what reaches the destinations that never see the history. Publishing is asynchronous, so nothing is returned and the alert appears in the queue a moment later; search for it rather than expecting an id back. Severities the platform does not store are not stored here either - LOW is forwarded but never queued.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

An alert to raise for something nothing automatic would have caught. Published through the platform's own alert pipeline, so what lands is an ordinary alert - deduplicated, shaped and owned by the same rules, and forwarded to everything that processes alerts. Who raised it is recorded on the creation history entry and repeated in the message.

string
length ≤ 200

The channel it applies to, e.g. General, Finance, Support. Defaults to the alerts.manual.default.channel property.

string
length ≤ 4000

Optional note from the raiser, appended to the message below the fault so that it travels with the alert but takes no part in deduplication

string
required
length between 1 and 20000

What has gone wrong, in the raiser's own words. Deduplication is derived from this the same way it is for an alert the platform raises, and from its first paragraph in particular - so two people reporting one fault in the same words are grouped, and the context appended below is not part of it.

string
required

CRITICAL, HIGH, MEDIUM, LOW or INFO. LOW is forwarded but never stored, exactly as it is for an alert the platform raises, so an alert raised at LOW will not appear in the queue.

string
length ≤ 32

Distributed trace id the issue was seen on, so the request can be pulled up in Jaeger. The id on its own, not the URL it appears in. Left out, the alert carries the trace of this call, the same way a platform alert carries the trace of whatever was happening when it was raised.

Responses
204

No Content - the alert has been published

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json