Webhooks
Überblick
Abschnitt betitelt „Überblick“Ein generischer Webhook sendet bei jeder Statusänderung eines Monitors ein
HTTP-POST an einen beliebigen Endpunkt. Das ist der flexibelste Weg, OKStatus
mit einem Werkzeug zu verbinden, für das es keinen eigenen Kanal gibt — und er
steht in jedem Tarif zur Verfügung, Free eingeschlossen.
Einrichtung
Abschnitt betitelt „Einrichtung“- Gehen Sie zu Alarmierung → Kanäle → Kanal hinzufügen → Webhook.
- Geben Sie die Ziel-URL ein.
- Optional: Legen Sie ein Geheimnis fest — es wird bei jedem Aufruf mitgeschickt, sodass Sie Anfragen ohne dieses Geheimnis ablehnen können.
- Klicken Sie auf Testen und hängen Sie den Kanal dann an Ihre Monitors.
Die URL muss öffentlich auflösbar sein: Eine Adresse, die auf eine private oder reservierte IP zeigt, wird abgelehnt — sowohl beim Speichern des Kanals als auch erneut beim Senden.
Payload
Abschnitt betitelt „Payload“{ "event": "monitor.down", "monitor": { "name": "Hauptwebsite", "url": "https://example.com" }, "region": "fr-dc3", "timestamp": "2026-09-09T14:30:00.000Z"}Die Payload ist bewusst klein und stabil. Alles Weitere — HTTP-Code, Latenz, Verfügbarkeit — ist einen authentifizierten Aufruf der REST-API entfernt, adressiert über Namen oder URL des Monitors.
Verfügbare Ereignisse
Abschnitt betitelt „Verfügbare Ereignisse“event | Gesendet, wenn |
|---|---|
monitor.down | Der Monitor als ausgefallen bestätigt ist |
monitor.degraded | Teilausfall, langsame Antwort oder eine unerwartete Weiterleitung |
monitor.up | Der Monitor sich erholt hat |
monitor.paused | Der Monitor pausiert wurde |
Es gibt kein incident.*-Ereignis: Vorfälle schreiben Sie, die Engine erkennt
sie nicht. Lesen oder erstellen Sie sie über die
Vorfall-API.
Sicherheit
Abschnitt betitelt „Sicherheit“Wenn Sie am Kanal ein Geheimnis hinterlegen, trägt jede Anfrage es wortwörtlich
im Header X-Webhook-Secret. Vergleichen Sie es mit Ihrer eigenen Kopie und
verwerfen Sie die Anfrage, wenn es nicht übereinstimmt.
Eine Antwort außerhalb von 2xx markiert die Benachrichtigung am Alarm als fehlgeschlagen, sichtbar als ✗ neben dem Kanal im Alarmprotokoll. OKStatus wiederholt den Aufruf nicht.