Uptimeify Docs

Standard-Benachrichtigung

Die Standard-Benachrichtigungskette der Organisation: womit neue Nutzer starten, wenn ihre persönlichen Benachrichtigungen zum ersten Mal angelegt werden.

GET /api/im/notification-template · PUT /api/im/notification-template

Die Standard-Benachrichtigung ist die Kette, mit der eine Person startet. Sie wird in die persönlichen Benachrichtigungen einer Person kopiert, wenn diese angelegt werden, also beim ersten Öffnen durch die Person (oder durch einen Admin über Benachrichtigungen einer Person). Sie wirkt nicht rückwirkend: Wer schon Einstellungen hat, behält sie, und alle können ihre eigene Kette danach ändern.

sms- und voice-Schritte warten, bis die Person eine Telefonnummer bestätigt hat.

Authentifizierung

Erfordert die Rolle admin der Organisation, mit Sitzung oder organisationsweitem API-Token (der Token arbeitet mit der Rolle der Person, die ihn erstellt hat). Kundengebundene Tokens und Kunden-Logins werden abgewiesen. Incident Management muss für die Organisation aktiviert sein.

Standard-Benachrichtigung lesen

GET /api/im/notification-template

Beispiel (cURL)

curl -X GET "$BASE_URL/api/im/notification-template" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Antwort (Response)

{
  "channels": { "push": true, "sms": true, "voice": false, "email": true },
  "rules": [
    { "urgency": "high", "delayMinutes": 0, "channel": "push" },
    { "urgency": "high", "delayMinutes": 5, "channel": "sms" },
    { "urgency": "low", "delayMinutes": 0, "channel": "email" }
  ],
  "updatedAt": "2026-10-28T09:12:00.000Z"
}

Vor dem ersten Speichern lautet die Antwort { "channels": {}, "rules": [], "updatedAt": null }, und neue Nutzer starten ohne Kette.

Standard-Benachrichtigung setzen

PUT /api/im/notification-template

Ersetzt die ganze Vorlage.

Request Body

FeldTypPflichtBeschreibung
rulesarrayJaDie Kette, höchstens 64 Schritte. Jeder Schritt { "urgency": "high" oder "low", "delayMinutes": 0..1440, "channel": "push", "sms", "voice" oder "email" }. Jede Kombination aus Dringlichkeit, Verzögerung und Kanal höchstens einmal. Eine leere Liste (ohne channels) schaltet die Vorlage ab.
channelsobjectNeinDie vier Kanalschalter (push, sms, voice, email → boolean). Fehlt das Feld, ist ein Kanal genau dann an, wenn rules einen Schritt dafür hat.

Unbekannte Felder werden abgewiesen.

Beispiel (cURL)

curl -X PUT "$BASE_URL/api/im/notification-template" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rules":[{"urgency":"high","delayMinutes":0,"channel":"push"},{"urgency":"high","delayMinutes":5,"channel":"sms"},{"urgency":"low","delayMinutes":0,"channel":"email"}]}'

Antwort (Response)

200 OK: die Vorlage nach dem Schreiben, gleiche Form wie die GET-Antwort. Jede Änderung steht im Audit-Protokoll.

Häufige Fehler

  • 400 Bad Request (invalidRequestBody) bei ungültigem Body: unbekanntes Feld, unbekannter Kanal oder Dringlichkeit, Verzögerung außerhalb 0 bis 1440, mehr als 64 Schritte, dieselbe Kombination zweimal
  • 401 Unauthorized ohne Anmeldung
  • 403 Forbidden (forbidden), wenn du kein admin der Organisation bist
  • 403 Forbidden (imAccessDenied) für Kunden-Logins und kundengebundene Tokens
  • 403 Forbidden (imNotEnabled), wenn Incident Management für die Organisation nicht aktiviert ist

Auf dieser Seite