API сповіщень

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

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

GET /tenants/me/notifications

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

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

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

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

Поля відповіді

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

---

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

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

PATCH /tenants/me/notifications

Тіло запиту

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

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

Приклад: Увімкнення сповіщень 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
  }'

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

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

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

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

Помилки

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