API powiadomień

Autor: Zespół Aether365 Odbiorcy: Deweloperzy Zakres: Endpointy API ustawień powiadomień

Zarządzanie ustawieniami powiadomień e-mail i Teams dla uwierzytelnionego tenanta.

Pobieranie ustawień powiadomień

GET /tenants/me/notifications

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Pola odpowiedzi

Pole	Typ	Opis
emailOnComplete	boolean	Wysyła e-mail po pomyślnym zakończeniu skanu
emailOnFail	boolean	Wysyła e-mail, gdy skan się nie powiedzie
teamsWebhookUrl	string lub null	Adres URL incoming webhook Microsoft Teams
teamsOnComplete	boolean	Publikuje w Teams po zakończeniu skanu
teamsOnFail	boolean	Publikuje w Teams, gdy skan się nie powiedzie

---

Aktualizacja ustawień powiadomień

Aktualizuje ustawienia powiadomień. Zmieniane są tylko przesłane pola.

PATCH /tenants/me/notifications

Treść żądania

Wszystkie pola są opcjonalne. Dołącz tylko te pola, które chcesz zmienić.

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

Przykład: włączenie powiadomień Teams

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
  }'

Przykład: wyłączenie wszystkich powiadomień e-mail

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

Przykładowa odpowiedź

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

Błędy

Kod	HTTP	Opis
AUTH_INSUFFICIENT_SCOPE	403	Niewystarczające uprawnienia dla tej operacji
VALIDATION_ERROR	400	Nieprawidłowy format URL webhooka