Email Notifications

Supascale can send email notifications for important events, helping you stay informed about your infrastructure.

SMTP Configuration

Before receiving notifications, configure your SMTP settings.

Via Web UI

1. Go to Settings > SMTP
2. Enter your SMTP server details:
   • Host: SMTP server address
   • Port: Usually 587 (TLS) or 465 (SSL)
   • Username: Your SMTP username
   • Password: Your SMTP password
   • From Name: Sender display name
   • From Email: Sender email address
3. Click Test Connection to verify
4. Click Save

Via API

curl -X PUT https://supascale.example.com/api/v1/settings/smtp \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "host": "smtp.sendgrid.net",
    "port": 587,
    "username": "apikey",
    "password": "your-api-key",
    "fromName": "Supascale",
    "fromEmail": "[email protected]"
  }'

SMTP Provider Examples

SendGrid

{
  "host": "smtp.sendgrid.net",
  "port": 587,
  "username": "apikey",
  "password": "SG.xxxx"
}

Mailgun

{
  "host": "smtp.mailgun.org",
  "port": 587,
  "username": "[email protected]",
  "password": "your-mailgun-password"
}

AWS SES

{
  "host": "email-smtp.us-east-1.amazonaws.com",
  "port": 587,
  "username": "your-ses-smtp-username",
  "password": "your-ses-smtp-password"
}

Gmail

{
  "host": "smtp.gmail.com",
  "port": 587,
  "username": "[email protected]",
  "password": "your-app-password"
}

For Gmail, use an App Password instead of your regular password.

Notification Types

Supascale can notify you about various events:

Configuring Notifications

Via Web UI

1. Go to Settings > Notifications
2. Enter notification email addresses (comma-separated)
3. Select which event types to receive
4. Set minimum severity level
5. Click Save

Via API

curl -X PUT https://supascale.example.com/api/v1/settings/notifications \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["[email protected]", "[email protected]"],
    "enabled": {
      "security": true,
      "backups": true,
      "tasks": true,
      "system": true,
      "projects": true
    },
    "minSeverity": "warning"
  }'

Severity Levels

Security Notifications

Failed Login Alerts

Receive alerts after multiple failed login attempts:

{
  "type": "security.login_failed",
  "severity": "warning",
  "details": {
    "attempts": 5,
    "ip": "192.168.1.100",
    "timestamp": "2026-01-24T12:00:00Z"
  }
}

Security Scan Results

Get notified when security scans find issues:

1. Go to Settings > Security
2. Enable Scheduled Scans
3. Enable Email Notifications
4. Set Minimum Severity threshold

Backup Notifications

Enable for Scheduled Backups

1. Create or edit a scheduled backup task
2. Enable Notify on completion
3. Enable Notify on failure

Notification Content

Backup notifications include:

• Backup ID and type
• Success or failure status
• Duration and size
• Storage location
• Error details (if failed)

Task Notifications

Health Check Alerts

When health checks fail:

{
  "type": "task.health_check_failed",
  "severity": "critical",
  "details": {
    "taskName": "Project Health Check",
    "project": "production",
    "error": "Database connection refused",
    "lastSuccess": "2026-01-24T11:00:00Z"
  }
}

Configure Alert Threshold

Set how many failures before alerting:

curl -X PUT https://supascale.example.com/api/v1/tasks/task-123 \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "alertOnFailure": true,
    "failureThreshold": 3
  }'

System Notifications

SSL Certificate Expiry

Receive alerts before certificates expire:

• 30 days: Info notification
• 14 days: Warning notification
• 7 days: Critical notification

Disk Space Alerts

Update Notifications

Get notified when new Supascale versions are available.

Testing Notifications

Send Test Email

curl -X POST https://supascale.example.com/api/v1/settings/notifications/test \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

Verify SMTP Configuration

curl -X POST https://supascale.example.com/api/v1/settings/smtp/test \
  -H "X-API-Key: your-api-key"

Notification History

View Sent Notifications

curl https://supascale.example.com/api/v1/settings/notifications/history \
  -H "X-API-Key: your-api-key"

Response:

{
  "notifications": [
    {
      "id": "notif-123",
      "type": "backup.completed",
      "severity": "info",
      "sentTo": ["[email protected]"],
      "sentAt": "2026-01-24T07:00:00Z",
      "status": "delivered"
    }
  ]
}

Troubleshooting

Notifications Not Sending

1. Verify SMTP credentials are correct
2. Test SMTP connection
3. Check spam/junk folders
4. Verify notification emails are configured
5. Check notification types are enabled

Delayed Notifications

1. Check SMTP server response times
2. Verify queue processing is running
3. Check activity logs for send attempts

Email Marked as Spam

1. Use a reputable SMTP provider
2. Configure SPF and DKIM records
3. Use a verified sender domain
4. Avoid spam trigger words in subjects

Best Practices

1. Use dedicated email addresses for operations alerts
2. Set appropriate severity thresholds to avoid alert fatigue
3. Configure backup notifications for all production backups
4. Enable security notifications for failed logins
5. Test notifications regularly to ensure delivery
6. Document notification recipients for team awareness