Simple Notification System

A lightweight notification system built with a plugin-based architecture. Example plugin implementations can be found in the plugins/ directory.

The system accepts HTTP requests on the /notification endpoint. When a notification is received, the system determines which plugin should handle it, passes necessary data to that plugin, and then delivers the generated notification using the configured transport layer.

A plugin is a simple function that receives notification data and plugin-specific configuration, and returns a notification message as a string. Plugins are loaded separately using Go's plugin package. Each plugin defines its own contract, including the structure of the notification data it expects and the configuration parameters it requires.

A transport is responsible for delivering the generated message to its destination (for example, Telegram).

Tech Stack

At the moment, the system is built without any external dependencies. The main design goal is to keep it simple.

Planned Improvements

• Scheduler
  A simple scheduler that allows configuring notification execution time and recurrence.

• More Transports
  Add additional transport implementations besides Telegram.

How to Use

Build and Run

Build core and plugins using make, then initialize config and run the server.

$ make core
$ make plugins
$ cd build
$ ./payr init
$ ./payr run

Triggering a Notification

Send an HTTP request to trigger a notification manually:

curl -X POST 127.0.0.1:8080/notification \
  -H "Content-Type: application/json" \
  -d '{"notification": "hello", "transports": [{"name": "telegram", "to": "<chat_id>"}], "meta": {"Name": "Guest"}}'