Notification webhook framework

[DeftNerd]

It would be nice if there was a global settings page and the framework to enable activity log notifications.

Notification when a page is created/modified/deleted
Notification when a user is created/modified/deleted
Notification when a file is created/modified/deleted

Notifications could be sent to several possible endpoints, but Slack and Rocket.Chat would be likely good first choices. Eventual additions could be email or messenger platform notifications to the admins

I support this suggestion. The ability to add a webhook for slack would remove quite a few other "nice to have" features from our wish list.

[dennisoderwald]

+1

[Shackelford-Arden]

Always a fan of webhooks! +1

[therealscottcarlow]

Definite +1

[jacksonp2008]

+1, anything in the works for this? IF not, can you point me to where I might make the changes myself?

[ssddanbrown]

Nothing currently in the works for this at the moment. Notifications is a wide topic so I'd say as a stage 1 to complete this issue the focus is put on the basics of the original issue description:

• Implementation of a global setting of slack-compatible web-hooks that are called upon page/chapter/book/user creation/modification/deletion.

The Web-hook URL and the subscribed events should be configurable and multiple web hooks should be able to be configured. For now it may be best to keep the contents of these hooks simple, With just the common text property within JSON as supported by slack, matter-most & teams.

There's currently an activity service which all activity creation runs through so that may be the best place to manage these events.

After the implementation of this we can then move focus to user-level notifications and expanding admin level notifications.

I am a bit worried about the performance cost of expanding out a notification system like this on a PHP based application. Once it gets to the point that saving a page fires of a couple of web-hooks and a bunch of emails things will start to get slow. I know a queue could be implemented but that will complicate application requirements, installation and maintenance.

[PriyaPallavi]

Hi @ssddanbrown , I am really interested in the idea of having notification webhook framework. I have divided it into three steps. They are:

1. Bookmarks/Subscription
2. Email Notification
3. Webhook Notification

Currently I am focusing on the first two modules.

Initial implementation can have the following:

• At first we need to have a subscription/bookmark button/icon for all the books, chapters and pages.
• If the user wants to subscribe to a particular book/chapter/page, he has to click on the bookmark icon available there.
• Once the user clicks on the bookmark icon, the details of the user along with the details of the bookmarked book/chapter/page will be stored in the database and a subscription message will be sent to all the subscribers of that page along with the new user using message queue.
• We will be providing this option of entering the credentials of message queue tool in the .env file while installation of the application only.
• If the credentials for the message queue tool installed in the system is not provided, the user can only see the notifications.
• In the global settings page we’ll have a message queue flag which will be turned on when you will provide the credentials of the installed message queue tool in the .env file.
• If there is no message queue tool (for example- RabbitMQ, ActiveMQ) installed on the user’s system, then there is no point of subscription.
• We can even build a notification system like in Facebook which will continuously update the user about his/her subscribed pages.
  Examples of such notifications are:
  • User subscribed to Book/Chapter/Page Name.
  • User created Chapter/Page Name.
  • User Modified Book/Chapter/Page Name.

Please do give your feedback.

[s0n-]

+1 for this as well - Slack is probably a great use case for this

[galaxyfeeder]

+1 very interesting for slack

[jacksonp2008]

Still interested in some way to get notifications from bookstack when someone creates a page or comments. I see that slack has an RSS plugin, so if you output an RSS feed that might be a quick win and I could integrate into slack.

"The RSS integration allows you to subscribe to an RSS or Atom feed URL and receive updates in Slack. Feeds will be fetched periodically, and new items will be posted to the specified channel."

thanks all