API сповiщень

Керування налаштуваннями сповiщень електронною поштою та Teams для автентифiкованого tenant'у.

Отримання налаштувань сповiщень

GET /tenants/me/notifications

Приклад запиту

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

Приклад вiдповiдi

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

Поля вiдповiдi

Поле	Тип	Опис
emailOnComplete	boolean	Надсилати лист при успiшному завершеннi сканування
emailOnFail	boolean	Надсилати лист при помилцi сканування
teamsWebhookUrl	string або null	URL вхiдного webhook Microsoft Teams
teamsOnComplete	boolean	Публiкувати в Teams при завершеннi сканування
teamsOnFail	boolean	Публiкувати в Teams при помилцi сканування

---

Оновлення налаштувань сповiщень

Оновлює налаштування сповiщень. Змiнюються лише включенi поля.

PATCH /tenants/me/notifications

Тiло запиту

Всi поля необов'язковi. Включайте лише тi поля, якi хочете змiнити.

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

Приклад: Увiмкнення сповiщень Teams

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

Приклад: Вимкнення всiх email-сповiщень

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

Приклад вiдповiдi

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

Помилки

Код	HTTP	Опис
AUTH_INSUFFICIENT_SCOPE	403	Недостатньо дозволiв для цiєї дiї
VALIDATION_ERROR	400	Невалiдний формат URL webhook