Skip to content

API Ειδοποιήσεων

Maintained by: Aether365 Team Audience: Developers Scope: Notification settings API endpoints

Διαχείριση ρυθμίσεων ειδοποιήσεων email και Teams για το πιστοποιημένο tenant.

Ανάκτηση Ρυθμίσεων Ειδοποιήσεων

GET /tenants/me/notifications

Παράδειγμα Αιτήματος

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

Παράδειγμα Απάντησης

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

Πεδία Απάντησης

ΠεδίοΤύποςΠεριγραφή
emailOnCompletebooleanΑποστολή email όταν μια σάρωση ολοκληρωθεί επιτυχώς
emailOnFailbooleanΑποστολή email όταν μια σάρωση αποτύχει
teamsWebhookUrlstring ή nullURL incoming webhook Microsoft Teams
teamsOnCompletebooleanΔημοσίευση στο Teams όταν μια σάρωση ολοκληρωθεί
teamsOnFailbooleanΔημοσίευση στο Teams όταν μια σάρωση αποτύχει

Ενημέρωση Ρυθμίσεων Ειδοποιήσεων

Ενημερώνει τις ρυθμίσεις ειδοποιήσεων. Αλλάζουν μόνο τα πεδία που συμπεριλαμβάνετε.

PATCH /tenants/me/notifications

Σώμα Αιτήματος

Ολα τα πεδία είναι προαιρετικά. Συμπεριλάβετε μόνο τα πεδία που θέλετε να αλλάξετε.

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

Παράδειγμα: Ενεργοποίηση ειδοποιήσεων Teams

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

Παράδειγμα: Απενεργοποίηση όλων των ειδοποιήσεων email

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

Παράδειγμα Απάντησης

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

Σφάλματα

ΚωδικόςHTTPΠεριγραφή
AUTH_INSUFFICIENT_SCOPE403Ανεπαρκή δικαιώματα για αυτή την ενέργεια
VALIDATION_ERROR400Μη έγκυρη μορφή URL webhook
Σας φάνηκε χρήσιμη αυτή η σελίδα;