Teavituste API

Hallake autenditud halduskeskkonna e-posti ja Teamsi teavitusseadeid.

Teavitusseadete kättesaamine

GET /tenants/me/notifications

Näidispäring

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

Näidisvastus

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

Vastuse väljad

Väli	Tüüp	Kirjeldus
emailOnComplete	boolean	Saada e-kiri, kui skaneerimine lõpeb edukalt
emailOnFail	boolean	Saada e-kiri, kui skaneerimine ebaõnnestub
teamsWebhookUrl	string või null	Microsoft Teamsi sissetuleva veebipääsu URL
teamsOnComplete	boolean	Postita Teamsi, kui skaneerimine lõpeb
teamsOnFail	boolean	Postita Teamsi, kui skaneerimine ebaõnnestub

---

Teavitusseadete uuendamine

Uuendab teavitusseadeid. Muudetakse ainult kaasatud välju.

PATCH /tenants/me/notifications

Päringu keha

Kõik väljad on valikulised. Lisage ainult need väljad, mida soovite muuta.

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

Näide: Teamsi teavituste lubamine

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

Näide: kõigi e-posti teavituste keelamine

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

Näidisvastus

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

Vead

Kood	HTTP	Kirjeldus
AUTH_INSUFFICIENT_SCOPE	403	Selle toimingu jaoks pole piisavalt õigusi
VALIDATION_ERROR	400	Vigane veebipääsu URL-i formaat