Need help implementing a custom listener

[felixschndr]

Hey there,

I am trying to build a custom apprise listener and need some help with that.
I want to be able to send a notification from Mealie which supports sending notification with apprise to my application. The application shall listen for the notification and then do stuff. However, I am currently failing to get a minimum working example running.

This is the code I am testing with:

from apprise.decorators import notify

@notify(on="foobar://192.168.1.226:1234?notify_on_complete=0")
def my_handler(body, meta, title=None, notify_type=None, *args, **kwargs):

    print(f"Received notification: {notify_type}: {title} - {body}")

and

apprise -vv -b "use defaults" "foobar://192.168.1.226:1234" --plugin-path source/test.py 
2025-08-02 12:42:25,573 - INFO - Loaded custom notification: foobar://
2025-08-02 12:42:25,574 - WARNING - An exception occured sending a Custom - foobar notification.

Essentially, I want to be able to add my custom URL to Mealie (where I cant add any plugins like I did in the cli) which then sends the notification to my application.

I was unable to get this working using the docs. Can you help me with that?
How has my python file to look like?

[caronc]

Adding more verbosity -vvv identifies the actual error you're getting

apprise -vvv -b "use defaults" "foobar://192.168.1.226:1234" --plugin-path ~/plugin.py 
...<irrelivante logging>
2025-08-02 11:01:25,072 - TRACE - Custom - foobar URL foobar://192.168.1.226:1234 unpacked as:
schema="foobar"
host="192.168.1.226"
port="1234"
url="foobar://192.168.1.226:1234"
2025-08-02 11:01:25,073 - DEBUG - Loaded Custom - foobar URL: foobar://
2025-08-02 11:01:25,073 - WARNING - An exception occured sending a Custom - foobar notification.
2025-08-02 11:01:25,073 - DEBUG - <class 'apprise.decorators.base.CustomNotifyPlugin.instantiate_plugin.<locals>.CustomNotifyPluginWrapper'> Exception: my_handler() got multiple values for argument 'meta'

I will admite, the error doesn't help the situation at first glance, so I did have to do a bit of digging. But it just turns out to be the order that you're passing in the data that is causing the problem. Place meta after notify_type and you're good to go 🚀

@notify(on="foobar://192.168.1.226:1234?notify_on_complete=0")
def my_handler(body, title=None, notify_type=None, meta=None, *args, **kwargs):

    print(f"Meta: {meta}")
    print("---")
    print(f"Received notification: {notify_type}: {title} - {body}")

[felixschndr]

Thank you very much!

I got the following working:

from apprise.decorators import notify
from flask import Blueprint, Flask

base_bp = Blueprint("base_bp", __name__, url_prefix="/")
app = Flask(__name__)

@notify(on="foobar://192.168.1.226:1234?notify_on_complete=0")
def my_handler(body, title=None, notify_type=None, meta=None, *args, **kwargs):
    print(f"Meta: {meta}")
    print("---")
    print(f"Received notification: {notify_type}: {title} - {body}")


@base_bp.route("/status", methods=["GET"])
def my_other_function():
    print("I was called!")

if __name__ == "__main__":
    app.run(port=1235)

I am currently trying to figure out how to include that into the target application. As stated above

I want to be able to send a notification from Mealie which supports sending notification with apprise to my application. The application shall listen for the notification and then do stuff.

I don't control the source application (Mealie), so I am wondering wether this is even possible as when I run apprise -vvv -b "testing" "foobar://192.168.1.226:1234" I get the error Unparseable URL foobar://1...6:1234. Only when I run apprise -vvv -b "testing" "foobar://192.168.1.226:1234" --plugin-path source/test.py it works.

Do I have to adapt the source application somehow to accept my custom handler or am I missing something? Thank you very much for your help @caronc :)

[caronc]

Mealie would have to have a PR done to where it initializes Aprise... see here.

They would just need to define a directory it's local instance of Apprise could reference for plugins (where you would provide just a python file with your @notify(on=...) in it. If Mealie was in a contrainer, this wouldn't be a problem, as you would just update your docker container to add a volume to the path you could drop your custom files into.

[felixschndr]

Thank you very much! I was able to figure this out with your help :)