Notifications API

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

Manage email and Teams notification settings for the authenticated tenant.

Get Notification Settings

GET /tenants/me/notifications

Example Request

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

Example Response

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

Response Fields

Field	Type	Description
emailOnComplete	boolean	Send email when a scan completes successfully
emailOnFail	boolean	Send email when a scan fails
teamsWebhookUrl	string or null	Microsoft Teams incoming webhook URL
teamsOnComplete	boolean	Post to Teams when a scan completes
teamsOnFail	boolean	Post to Teams when a scan fails

---

Update Notification Settings

Updates notification settings. Only the fields you include are changed.

PATCH /tenants/me/notifications

Request Body

All fields are optional. Include only the fields you want to change.

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

Example: Enable Teams notifications

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

Example: Disable all email notifications

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

Example Response

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

Errors

Code	HTTP	Description
AUTH_INSUFFICIENT_SCOPE	403	Insufficient permissions for this action
VALIDATION_ERROR	400	Invalid webhook URL format