Varsler-API

Vedlikeholdt av: Aether365 Team Malgruppe: Utviklere Omfang: API-endepunkter for varslingsinnstillinger

Administrer e-post- og Teams-varslingsinnstillinger for den autentiserte leietakeren.

Hent varslingsinnstillinger

GET /tenants/me/notifications

Eksempelforespørsel

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

Eksempelrespons

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

Responsfelt

Felt	Type	Beskrivelse
emailOnComplete	boolean	Send e-post nar en skanning fullores
emailOnFail	boolean	Send e-post nar en skanning feiler
teamsWebhookUrl	string eller null	Innkommende webhook-URL for Microsoft Teams
teamsOnComplete	boolean	Send melding til Teams nar en skanning fullores
teamsOnFail	boolean	Send melding til Teams nar en skanning feiler

---

Oppdater varslingsinnstillinger

Oppdaterer varslingsinnstillinger. Kun feltene du inkluderer endres.

PATCH /tenants/me/notifications

Forespørselsbrødtekst

Alle felt er valgfrie. Inkluder kun feltene du vil endre.

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

Eksempel: Aktiver Teams-varsler

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

Eksempel: Deaktiver alle e-postvarsler

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

Eksempelrespons

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

Feil

Kode	HTTP	Beskrivelse
AUTH_INSUFFICIENT_SCOPE	403	Utilstrekkelige tillatelser for denne handlingen
VALIDATION_ERROR	400	Ugyldig webhook-URL-format