Aviserings-API

Underhålls av: Aether365 Team Målgrupp: Utvecklare Omfattning: API-endpoints för aviseringsinställningar

Hantera e-post- och Teams-aviseringsinställningar för den autentiserade tenanten.

Hämta aviseringsinställningar

GET /tenants/me/notifications

Exempelbegäran

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

Exempelsvar

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

Svarsfält

Fält	Typ	Beskrivning
emailOnComplete	boolean	Skicka e-post när en skanning slutförs utan problem
emailOnFail	boolean	Skicka e-post när en skanning misslyckas
teamsWebhookUrl	string eller null	Microsoft Teams inkommande webhook-URL
teamsOnComplete	boolean	Skicka till Teams när en skanning slutförs
teamsOnFail	boolean	Skicka till Teams när en skanning misslyckas

---

Uppdatera aviseringsinställningar

Uppdaterar aviseringsinställningar. Bara fält du inkluderar ändras.

PATCH /tenants/me/notifications

Begärandekropp

Alla fält är valfria. Inkludera bara fält du vill ändra.

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

Exempel: Aktivera Teams-aviseringar

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

Exempel: Inaktivera alla e-postaviseringar

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

Exempelsvar

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

Fel

Kod	HTTP	Beskrivning
AUTH_INSUFFICIENT_SCOPE	403	Otillräckliga behörigheter för denna åtgärd
VALIDATION_ERROR	400	Ogiltigt webhook-URL-format