Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 Feature: Notifications (webhook?) #88

Open
Hukuma1 opened this issue Jan 26, 2023 · 14 comments
Open

🚀 Feature: Notifications (webhook?) #88

Hukuma1 opened this issue Jan 26, 2023 · 14 comments
Labels
feature New feature or request

Comments

@Hukuma1
Copy link

Hukuma1 commented Jan 26, 2023

🔖 Feature description

The ability to send a notification of certain events. On link open, maybe on download of a file, view, etc. Apprise is the gold-standard since it houses basically any notification system you could possibly have/run/want. FOSS as well. https://github.com/caronc/apprise

🎤 Pitch

When X share is opened and/or downloaded, I could receive a notification to my Home Assistant which in turn sends me a push notification to my iPhone. Or you might want a message in Discord sent to you. Or Telegram. Endless possibilities. Apprise also has e-mail notifications so in theory could simplify the current e-mail notification code? (not sure)

@Hukuma1 Hukuma1 added the feature New feature or request label Jan 26, 2023
@stonith404
Copy link
Owner

Nice idea but Apprise hasn't a package for node.js, has it? The backend is written in typescript so we would have to create a micro service only for Apprise and that's in my opinion too much work only for notifications.

Or did I miss something?

@sebastian-b00
Copy link

Yes, currently there is no stable nodejs package available.
I think this could work, but it may take more work than you would like to use in developing a feature.

@Hukuma1
Copy link
Author

Hukuma1 commented Jan 31, 2023

Yeah, apologies in advance. I wasn't sure what underlying technologies both use and wasn't aware they were incompatible.

Is it possible to just implement Webhooks? Would that be a much smaller ask? Seems most other services (e.g. Telegram, Home Assistant) would still have support for receiving Webhooks.

@stonith404
Copy link
Owner

Yeah webhooks would be easier to implement I think. Which events should trigger the webhook?

@stonith404
Copy link
Owner

@Hukuma1 Just to understand, would you mind to share why you think it would be nice that you can get notifications in e.g Telegram or Discord? Do you have a specific use case?

@Hukuma1
Copy link
Author

Hukuma1 commented Jan 31, 2023

Oh I just grabbed a popular chat program as an example where to send a notification (channel/DM). For my personal use case I would just like to get a push notification to my phone that someone interacted with my share. Since I already use Home Assistant it can be received by a webhook implementation. I just suggested other services to not only make it about my use case. :P

There's a few core events I would say: open and download. Separate, in case someone only clicked the link but didn't actually download? (not sure if each file in the share needs its own event, that's your call)

Future/bonus: If a share is about to expire, can send an alert? New file uploaded alert to your reverse share? Bad password/failed login alert? (notify you of someone trying to crack into your private share)

@stonith404
Copy link
Owner

@Hukuma1 Okay, thanks for your explanation. I'm looking into it, but currently I want to prioritize other issues if someone can't wait for this feature, feel free to create a PR :)

@Hukuma1
Copy link
Author

Hukuma1 commented Feb 1, 2023

Absolutely! No rush. Keep up the great work!

@Hukuma1 Hukuma1 changed the title 🚀 Feature: Notifications (AppRise) 🚀 Feature: Notifications (webhook?) Feb 1, 2023
@Zixim
Copy link

Zixim commented Aug 25, 2023

+1 for webhook implementation

@stonith404
Copy link
Owner

Could you guys suggest me a list of events that would be nice to have for webhooks? E.g share.create

@Zixim
Copy link

Zixim commented Aug 28, 2023

when a file is uploaded or downloaded or deleted to/from a (reverse)share. Basically all events related to file movements.
For me, the file upload to any reverse share would be the most interesting one to have.

@Hukuma1
Copy link
Author

Hukuma1 commented Aug 30, 2023

share.view = entered share but did not download anything
share.download = downloaded
share.accessfail = failed pw login (maybe can be invoked if failed X amount of times, eg 3 wrong password attempts)

@CrazyWolf13
Copy link

CrazyWolf13 commented May 1, 2024

@stonith404

Could you guys suggest me a list of events that would be nice to have for webhooks? E.g share.create

+1 For some sort of notification service, at best ntfy.sh integration.

For me the following things would be nice:

  • share viewed
  • share downloaded
  • share uploaded
  • successful login (with IP)
  • failed login (with IP)

Greetings from Switzerland :)

@maurxce
Copy link
Contributor

maurxce commented May 14, 2024

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants