 |
This page contains one or more outdated guild links.
Guilds and the Tavern were removed from Habitica on August 8, 2023. If you know the status of the guild(s) mentioned in this page, please update their links and remove the template |
Description
NotificaBot is a bot for handling Guild & Party chat notifications in Habitica. NotificaBot works by scanning chat messages for @username mentions of subscribed users and then notifies them of the mention by private message.
The point is that user should have push notifications enabled in the Habitica iOS or Android app for private messages. Then when someone mentions their username in Guild chat, @NotificaBot will send them a private message and then they will get a push notification for that. So it's effectively push notifications for Guild chat mentions. And it works with email notifications too, if push notifications are not enabled.
Usage
To subscribe to NotificaBot notifications, go to NotificaBot subscriptions Guild and send a message to the chat as instructed in the Guild description.
Note! The bot does not handle setting up Webhooks, so they need to be set up separately. For setting up a webhook to make NotificaBot listen in a specific Guild, you can ask for more information in the Guild chat if you are not familiar with creating webhooks via Habitica API.
Setting up custom instance[]
You are free to use the "official" instance by following the instructions above. Setting up a custom instance is not required. But if you want to customize it, then setting up a custom instance will be needed.
NotificaBot is running as a serverless function in Netlify and it uses JSONbin.io for storing the subscriptions. You are welcome to fork it and run your own custom instance of it in Netlify or some other cloud function provider. (Note that the incoming event/params format might differ depending on the provider. Netlify functions run in AWS Lambda, so it should work there at least.) Both of these services are free (with some limitations), so running an instance does not cost anything.
You will need to provide the ENV variables for Habitica API & JSONbin API calls. You can search the code for "process.env." to find what variables are used.