Skip to main content

notify

notify — ɳSelf documentation.

Notify Plugin

Multi-channel notification dispatch: SMTP, SMS, and push. Free: MIT licensed.

Install

nself plugin install notify

What It Does

Provides a unified API for sending notifications across SMTP email, SMS, and push channels. Queues notifications and handles retries. Free tier supports SMTP, basic SMS, and push. For A/B testing, scheduled delivery, and user preferences, see plugin-notify-pro.

Configuration

Env VarDefaultDescription
NOTIFY_PORT3052Notify service port
NOTIFY_SECRET(auto-generated)Internal auth secret
NOTIFY_SMTP_HOSTnoneSMTP server hostname
NOTIFY_SMTP_PORT587SMTP port
NOTIFY_SMTP_USERnoneSMTP username
NOTIFY_SMTP_PASSnoneSMTP password
NOTIFY_SMS_PROVIDERnoneSMS provider (twilio, etc.)
NOTIFY_FCM_KEYnoneFirebase Cloud Messaging key

Ports

PortPurpose
3052Notify service REST API

Database Tables

2 tables added to your Postgres database:

  • np_notify_queue: queued notifications
  • np_notify_log: delivery history and status

Nginx Routes

None, notify service is internal only.

API

GET  /health: Health check
POST /notifications/email: Send email
POST /notifications/sms: Send SMS
POST /notifications/push: Send push notification
GET  /notifications: List notification history