BookStackApp / BookStack

A platform to create documentation/wiki content built with PHP & Laravel
https://www.bookstackapp.com/
MIT License
15.16k stars 1.89k forks source link

Adding Telegram notifications - addiational to E-Mail notifications #4595

Open towerplease opened 1 year ago

towerplease commented 1 year ago

Describe the feature you'd like

Basically, the desired function would be very similar to the already existing e-mail notification.

I would aim to be able to create a Telegram bot via token/channel ID per permission group.

Then the Telegram notifications should be sent to the specified bot, with the same binding logic as the e-mails.

Perhaps a "general" configuration would be useful, cross-role, in which the notifications can be generally controlled and black or whitelists for users / groups could be defined. What I could also imagine useful would be "keywords", so that only notifications are sent if a new/edited page contains one of the keywords, but that would already be far more than requested.

Describe the benefits this would bring to existing BookStack users

The advantage of this would be that additional notification technology is provided.

I have many users who check their e-mails little or not at all and therefore miss new posts. Since we use different groups with bots in Telegram, such a notification would be very handy.

I would create a Telegram bot for this that has an affiliation per role so you can add it to the (in our case) existing department group.

This would then send everyone a notification when new posts are available (training material).

Can the goal of this request already be achieved via other means?

It could be done through the email notifications, as mentioned earlier. Here, however, there is always the problem that the e-mail goes down with people or simply the e-mails are not retrieved.

We don't have a shared domain, everyone works with their personal email accounts.

Have you searched for an existing open/closed issue?

How long have you been using BookStack?

1 to 5 years

Additional context

No response

sysadminpower2019 commented 10 months ago

oh this is great. I would also really support integrating more functionality with Telegram.

ssddanbrown commented 10 months ago

From my perspective, I really don't want to go down the route of supporting many specific providers for things like notifications, and I try to avoid supporting external systems where possible to keep maintenance reasonable, preferring standards instead where possible.

I have not really looked into the Telegram APIs, but if you just want activity going across, then it might be possible to adapt our webhooks to go across to Telegram. I recently did this as an example hack for Pushover here: https://www.bookstackapp.com/hacks/pushover-webhooks/ Might be possible to do the same for Telegram.