Notifications API

Onderhouden door: Aether365 Team Doelgroep: Ontwikkelaars Scope: API endpoints voor meldingsinstellingen

Beheer e-mail- en Teams-meldingsinstellingen voor de geauthenticeerde tenant.

Meldingsinstellingen ophalen

GET /tenants/me/notifications

Voorbeeldverzoek

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

Voorbeeldresponse

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

Responsevelden

Veld	Type	Beschrijving
emailOnComplete	boolean	E-mail versturen wanneer een scan succesvol is voltooid
emailOnFail	boolean	E-mail versturen wanneer een scan mislukt
teamsWebhookUrl	string of null	Microsoft Teams inkomende webhook-URL
teamsOnComplete	boolean	Bericht in Teams plaatsen wanneer een scan is voltooid
teamsOnFail	boolean	Bericht in Teams plaatsen wanneer een scan mislukt

---

Meldingsinstellingen bijwerken

Werkt meldingsinstellingen bij. Alleen de meegestuurde velden worden gewijzigd.

PATCH /tenants/me/notifications

Verzoekbody

Alle velden zijn optioneel. Stuur alleen de velden mee die je wilt wijzigen.

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

Voorbeeld: Teams-meldingen inschakelen

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

Voorbeeld: alle e-mailmeldingen uitschakelen

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

Voorbeeldresponse

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

Fouten

Code	HTTP	Beschrijving
AUTH_INSUFFICIENT_SCOPE	403	Onvoldoende machtigingen voor deze actie
VALIDATION_ERROR	400	Ongeldig webhook-URL-formaat