☰
Navigation :

Getting started

What is the Atoti Notification Service

This service can be used in a Spring Boot application to publish Notifications intended to be consumed by an EventSource client. It includes a REST API to connect to the server, receive real-time notifications, and perform actions on the notifications. The R&D Solutions team provides an EventSource consumer that can be integrated with any Atoti UI.

Why use the Atoti Notification Service

The primary goals of the Atoti Notification Service are:

  • Provide a simple and intuitive mechanism for communicating information to users from your application
  • Use a standardized format - Server-Sent Events (SSE) - for publishing notifications that can be consumed by any EventSource client
  • Allow notifications to be actioned via REST, and provide reasonable default actions while allowing for custom actions
  • Maintain notification statuses on per-user basis
  • Provide a means of restricting notifications to specific users or roles

For clarity, the service is NOT intended to:

  • Provide user-to-user or server-to-server messaging
  • Persist notifications across server restarts
  • Send notifications via email or other external services

Setting up the service

To start using the Atoti Notification Service, add the following dependency to your project:

<dependency>
    <groupId>com.activeviam.solutions.services</groupId>
    <artifactId>notification-service</artifactId>
</dependency>

Configuring the service

The Atoti Notification Service does not require any configuration to be used, but does provide a few properties for customizing its behavior. See Notification Service properties for more information on these properties.

note

The Atoti Notification Service uses Spring Boot’s spring.application.name property to identify the application responsible for sending each notification. While this property is not required, we highly recommended setting it to a meaningful value to help distinguish notifications between different applications. If not set, the service will use a default value of Unnamed Spring server.

Using the service

Once you’re all set up, you can start creating notifications. To learn about creating, and publishing notifications, see Managing notifications.