Notifications API

Betreut von: Aether365 Team Zielgruppe: Entwickler Umfang: API-Endpunkte für Benachrichtigungseinstellungen

Verwalten Sie die E-Mail- und Teams-Benachrichtigungseinstellungen für den authentifizierten Tenant.

Benachrichtigungseinstellungen abrufen

GET /tenants/me/notifications

Beispielanfrage

curl https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>"

Beispielantwort

{
  "success": true,
  "data": {
    "emailOnComplete": true,
    "emailOnFail": true,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Antwortfelder

Feld	Typ	Beschreibung
emailOnComplete	boolean	E-Mail senden, wenn ein Scan erfolgreich abgeschlossen wird
emailOnFail	boolean	E-Mail senden, wenn ein Scan fehlschlägt
teamsWebhookUrl	string oder null	Microsoft Teams Incoming Webhook URL
teamsOnComplete	boolean	Teams-Nachricht senden, wenn ein Scan abgeschlossen wird
teamsOnFail	boolean	Teams-Nachricht senden, wenn ein Scan fehlschlägt

---

Benachrichtigungseinstellungen aktualisieren

Aktualisiert die Benachrichtigungseinstellungen. Nur die angegebenen Felder werden geändert.

PATCH /tenants/me/notifications

Anfragekörper

Alle Felder sind optional. Geben Sie nur die Felder an, die Sie ändern möchten.

{
  "emailOnComplete": true,
  "emailOnFail": true,
  "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
  "teamsOnComplete": true,
  "teamsOnFail": false
}

Beispiel: Teams-Benachrichtigungen aktivieren

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "teamsWebhookUrl": "https://outlook.office.com/webhook/your-webhook-url",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }'

Beispiel: Alle E-Mail-Benachrichtigungen deaktivieren

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "emailOnComplete": false,
    "emailOnFail": false
  }'

Beispielantwort

{
  "success": true,
  "data": {
    "emailOnComplete": false,
    "emailOnFail": false,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Fehler

Code	HTTP	Beschreibung
AUTH_INSUFFICIENT_SCOPE	403	Unzureichende Berechtigungen für diese Aktion
VALIDATION_ERROR	400	Ungültiges Webhook-URL-Format