reactioncommerce / api-plugin-notifications Goto Github PK

Opening this because @spencern has mentioned several times that we need to do this and he's very right so I wanted to get this spec'd out so it could be worked on when appropriate.

The current notification system does a good job sending Order notifications, but needs to be refactored to be more general and allow configuring a notification for almost any system event, plus allow which events get SMS and in-app notifications. The current events are essentially hard-coded.

My initial proposal for how this should work would be:

1. Settings panel searches for all available system events (Hooks) and allows you select which events should receive either an in-app notification and/or an SMS (maybe also Slack could go here also?). This should be dynamic so as system events are added they are automatically appear in this settings panel. Probably with a default set for basic Order notification similar to what we have now.
2. You should also be able to configure the content of the message similar to how you can do now with emails (via templates probably?).
3. Should be extendable with other system notification types. (Hopefully Slack could be an included example of this?)
4. Should listen for all system events, check configuration, and then send appropriate notification.
5. Optionally could listen for Errors and allow you to send notification when certain types of errors appear.

Sort of a "sub-task" of reactioncommerce/reaction#429 ( as was the original notifications system I suppose)