Documentation
v0.5
Flows
Sending Notifications

Sending Notifications

Notifications are sent by publishing messages to your configured broker. Notiway consumes them via the buffer plugin and delivers them to connected clients over WebSocket.

  graph LR
    A[Your Service] -->|Publish| B[Broker]
    B --> C[Buffer]
    C --> D[Notiway Notify]
    D -->|WebSocket| E[Connected Clients]

You don’t send notifications directly to Notiway. Your backend services publish messages to the broker (SNS, RabbitMQ, Redis, etc.), which decouples your services from the gateway and enables horizontal scaling.

Notification Structure

All notifications follow the same JSON structure, regardless of which broker you use. For the full specification including all fields, routing options, and persistence settings, see Producers.

Publishing to Your Broker

Each broker plugin documents how to publish notifications from your backend, including connection details, SDKs, and code examples:

Receiving Notifications