API notifikácií

Správa nastavení e-mailových a Teams notifikácií pre autentifikovaného tenanta.

Získanie nastavení notifikácií

GET /tenants/me/notifications

Príklad požiadavky

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

Príklad odpovede

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

Polia odpovede

Pole	Typ	Popis
emailOnComplete	boolean	Poslať e-mail po úspešnom dokončení skenu
emailOnFail	boolean	Poslať e-mail pri zlyhaní skenu
teamsWebhookUrl	string alebo null	URL prichádzajúceho webhooku Microsoft Teams
teamsOnComplete	boolean	Odoslať správu do Teams po dokončení skenu
teamsOnFail	boolean	Odoslať správu do Teams pri zlyhaní skenu

---

Aktualizácia nastavení notifikácií

Aktualizuje nastavenia notifikácií. Menia sa iba zahrnuté polia.

PATCH /tenants/me/notifications

Telo požiadavky

Všetky polia sú voliteľné. Zahrňte iba polia, ktoré chcete zmeniť.

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

Príklad: Zapnutie Teams notifikácií

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

Príklad: Vypnutie všetkých e-mailových notifikácií

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

Príklad odpovede

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

Chyby

Kód	HTTP	Popis
AUTH_INSUFFICIENT_SCOPE	403	Nedostatočné oprávnenia pre túto akciu
VALIDATION_ERROR	400	Neplatný formát URL webhooku