Getting Started

NotifyOn generates automatic notifications as a result of state changes on a particular model in a Rails application. It supports email messages and real-time events (via Pusher), while also storing each notification in your database so you can use, adjust, and display as you'd wish.

To install NotifyOn, add it to your Gemfile:

gem 'notify_on'

Then run the bundle command to install it.

$ bundle exec rails g notify_on:install

This adds the following to your project:

• Migration to create the notify_on_notifications table
• Default NotifyOn config
• Bulk notification settings

Migrate your database and then you're ready to go.

There are two ways in which you can configure a notification:

1. Within A Model
2. Bulk Configuration

Check out the pages above to learn more about each method. Note that it is recommended you read through the model config first, as it outlines the options for a notification that may be used in bulk.