API oznámení

Správa nastavení e-mailových a Teams oznámení pro autentizovaného tenanta.

Získání nastavení oznámení

GET /tenants/me/notifications

Příklad požadavku

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

Příklad odpovědi

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

Pole odpovědi

Pole	Typ	Popis
emailOnComplete	boolean	Odeslat e-mail po úspěšném dokončení skenu
emailOnFail	boolean	Odeslat e-mail při selhání skenu
teamsWebhookUrl	string nebo null	URL příchozího webhooku Microsoft Teams
teamsOnComplete	boolean	Odeslat zprávu do Teams po dokončení skenu
teamsOnFail	boolean	Odeslat zprávu do Teams při selhání skenu

---

Aktualizace nastavení oznámení

Aktualizuje nastavení oznámení. Změní se pouze pole, která uvedete.

PATCH /tenants/me/notifications

Tělo požadavku

Všechna pole jsou volitelná. Uveďte pouze pole, která chcete změnit.

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

Příklad: Zapnutí Teams oznámení

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

Příklad: Vypnutí všech e-mailových oznámení

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

Příklad odpovědi

{
  "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	Nedostatečná oprávnění pro tuto akci
VALIDATION_ERROR	400	Neplatný formát URL webhooku