Zwall
Talk to an Engineer
Talk to an Engineer
Documentation
Docs Home › Integrations › Notifications

Notifications

Notification channels

Status: SUPPORTED for email, webhook, Slack-style delivery as implemented by the Manager notification serviceAudience: Manager administrator

What it does

Delivers Manager notifications (security events, operator messages) over email, generic webhooks, Slack, and the console WebSocket. Templates live under /api/v1/email-templates.

Edition

SHARED. POST /api/v1/notifications and template writes may 403 on Enterprise without the notifications feature.

Prerequisites

  • SMTP server if email enabled
  • HTTPS webhook endpoint if webhook enabled
  • Admin JWT
  • notifications.* YAML

Required permissions / credentials

  • SMTP username/password (secret)
  • Webhook URL (secret if it embeds a token)
  • Slack incoming webhook if used (secret)

Configuration 

notifications:
  email:
    enabled: false
    smtp_host: "smtp.example.com"
    smtp_port: 587
    username: ""
    password: ""   # systemd credential
    from: "zwall@example.com"
    recipients: ["ops@example.com"]
  webhook:
    enabled: false
    url: "https://hooks.example.com/zwall"
    timeout: 10s

Per-admin preferences: GET/PUT /api/v1/notifications/preferences/me (channels, severity threshold, quiet hours).

Setup

  1. Set YAML; store SMTP password in credentials.
  2. Restart Manager.
  3. POST /api/v1/settings/notifications/test or POST /api/v1/email-templates/:id/test (sends real mail).
  4. Create a test notification via API or trigger a lab security event.

Verification

  • GET /api/v1/notifications/health
  • GET /api/v1/notifications?limit=50 shows rows
  • GET /api/v1/notifications/:id/deliveries shows channel attempts
  • Inbox / webhook receiver logs

Expected signals / results

Console unread count increments. Email uses templates when configured. Dedup may collapse repeats (count on the notification object).

Failure modes

Scroll sideways to see the full table. Use the arrow keys when focused.

SymptomMeaning
500 retrieve notificationsDB
test failsSMTP/TLS/auth
empty deliverieschannel disabled or quiet hours
403 licenseEnterprise feature gate

Troubleshooting

  • Preferences email_enabled false for that admin
  • severity_threshold filters low events
  • Webhook timeout default 10s
  • Do not log SMTP passwords

Security considerations

Notification bodies can include IPs and usernames. Treat mail as sensitive. Webhook URLs are capabilities.

Limitations

  • Not a paging vendor
  • Slack is protocol-level, not a Slack app marketplace product
  • No guaranteed exactly-once delivery