SPspectate
Alert sources

Fire a test alert

Fires an alert on the source that escalates like a real one (it notifies people) and resolves itself after a few minutes. Returns the event it made.

post/alert-sources/{source}/test

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

sourcestring uuid required

Alert source ID.

Response

The test event.

idstring uuid required

Event ID

received_atstring date-time required

When the request arrived

outcome'fired' | 'resolved' | 'updated' | 'test' | 'ignored' | 'rejected' required

What became of a request an alert source received.

fired <br/> It fired at least one new alert.
resolved <br/> It resolved at least one alert.
updated <br/> It repeated alerts that were already firing.
test <br/> A test request from the tool's own "test" button; no alert.
ignored <br/> Valid, but nothing to do (for example a resolve of an alert that isn't firing).
rejected <br/> Refused: bad signature, unreadable payload or a disabled source; see error.
summarystring nullable required

What happened, in words

errorstring nullable required

Why it was rejected, with outcome rejected

payloadobject nullable required

The request body as received: the tool's JSON, or {body, truncated} for mail and non-JSON bodies. Its shape is the tool's

Example response

{
  "summary": "2 alerts fired",
  "alerts": [
    {
      "title": "HighErrorRate",
      "dedupe_key": "4c3d9a…"
    }
  ]
}

Changes

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