Skip to content

Értesítések API

Az autentikált bérlő e-mail és Teams értesítési beállításainak kezelése.

Értesítési beállítások lekérdezése

GET /tenants/me/notifications

Példa kérés

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

Példa válasz

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

Válasz mezők

MezőTípusLeírás
emailOnCompletebooleanE-mail küldése a vizsgálat sikeres befejezésekor
emailOnFailbooleanE-mail küldése a vizsgálat sikertelensége esetén
teamsWebhookUrlstring vagy nullMicrosoft Teams bejövő webhook URL
teamsOnCompletebooleanTeams-üzenet küldése a vizsgálat befejezésekor
teamsOnFailbooleanTeams-üzenet küldése a vizsgálat sikertelensége esetén

Értesítési beállítások frissítése

Frissíti az értesítési beállításokat. Csak a megadott mezők módosulnak.

PATCH /tenants/me/notifications

Kéréstörzs

Minden mező opcionális. Csak a módosítani kívánt mezőket adja meg.

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

Példa: Teams értesítések engedélyezése

bash
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élda: Összes e-mail értesítés letiltása

bash
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élda válasz

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

Hibák

KódHTTPLeírás
AUTH_INSUFFICIENT_SCOPE403Elégtelen jogosultság a művelethez
VALIDATION_ERROR400Érvénytelen webhook URL formátum
Hasznos volt ez az oldal?