mealie/docs/docs/getting-started/notifications.md
Hayden 14b6ab7ec7
Feature/event notifications (#399)
* additional server events

* sort 'recent recipes' by updated

* remove duplicate code

* fixes #396

* set color

* consolidate tag/category pages

* set colors

* list unorganized recipes

* cleanup old code

* remove flash message, switch to global snackbar

* cancel to close

* cleanup

* notifications first pass

* test notification

* complete notification feature

* use background tasks

* add url param

* update documentation

Co-authored-by: hay-kot <hay-kot@pm.me>
2021-05-08 18:29:31 -08:00

2.2 KiB

Getting External Notifications

Apprise

Using the Apprise library Mealie is able to provided notification services for nearly every popular service. Some of our favorites are...

But there are some many to choose from! Take a look at their wiki for information on how to create their URL formats and that you can use to create a notification integration in Mealie.

Subscribe Events

There are several categories of events that mealie logs that can be broadcast with the notifications feature. You can also see a feed of your events in the Admin Dashboard

  • General Events
    • Application Startup
  • Recipe Events
    • Create Recipe
    • Delete Recipe
  • Database Events
    • Export/Import
    • Database Initialization
  • Scheduled Events
    • MealPlan Webhooks Sent
  • Group Events
    • Create/Delete Groups
  • User Events
    • User Creation
    • User Sign-up
    • Sign-up Token Creation
    • Invalid login attempts

In most cases the events will also provide details on which user performed the action. Now you'll know when your grandma deletes your favorite recipe!

!!! info This is a new feature and we are still working through all the possibilities of events. if you have an idea for an event let us know!

Creating a New Notification

New events can be created and viewed in admin Toolbox /admin/toolbox?tab=event-notifications. Select the "+ Notification" button and you'll be provided with a dialog. Complete the form using the URL for the service you'd like to connect to. Before saving be sure to use the test feature.

!!! tip The feedback provided from the test feature is only an indicated of if the URL you provided is valid, not if the message was successfully sent. Be sure to check the notification feed for the test message.

Add Notification Image

Examples

Discord

Discord

Gotify

Gotify