Skip to main content

mqttwarn - subscribe to MQTT topics and notify pluggable services

Project description License


To warn, alert, or notify.


mqttwarn - subscribe to MQTT topics and notify pluggable services.


mqttwarn subscribes to any number of MQTT topics and publishes received payloads to one or more notification services after optionally applying sophisticated transformations.

It comes with over 70 notification handler plugins for a wide range of notification services and is very open to further contributions. You can enjoy the alphabetical list of plugins within the handbook_services.

A picture says a thousand words.


This program subscribes to any number of MQTT topics (which may include wildcards) and publishes received payloads to one or more notification services, including support for notifying more than one distinct service for the same message.

Notifications are transmitted to the appropriate service via plugins. mqttwarn provides built-in plugins for a number of services and you can easily add your own.

A more detailed blog post about what mqttwarn can be used for is available at

For example, you may wish to submit an alarm published as text to the MQTT topic home/monitoring/+ as notification via e-mail and Pushover.


The handbook is the right place to read all about mqttwarn’s features and service plugins.



pip install --upgrade mqttwarn

You can also add support for a specific service plugin:

pip install --upgrade 'mqttwarn[xmpp]'

You can also add support for multiple services, all at once:

pip install --upgrade 'mqttwarn[apprise,asterisk,nsca,osxnotify,tootpaste,xmpp]'

Container image

For running mqttwarn on a container infrastructure like Docker or Kubernetes, corresponding images are automatically published to the GitHub Container Registry (GHCR).


To learn more about this topic, please follow up reading the Docker handbook.


First, create configuration and custom Python starter files mqttwarn.ini and and edit them to your taste:

# Create configuration file
mqttwarn make-config > mqttwarn.ini

# Create file for custom functions
mqttwarn make-samplefuncs >


Running interactively

Just launch mqttwarn:

# Run mqttwarn

To supply a different configuration file or log file, optionally use:

# Define configuration file
export MQTTWARNINI=/etc/mqttwarn/acme.ini

# Define log file
export MQTTWARNLOG=/var/log/mqttwarn.log

# Run mqttwarn

Running notification plugins

For debugging, or other purposes, you might want to directly run an individual notification plugin without the dispatching and transformation machinery of mqttwarn.

We have you covered. To launch a plugin standalone, those commands will give you an idea how to pass relevant information on the command line using JSON:

# Launch "log" service plugin
mqttwarn --plugin=log --options='{"message": "Hello world", "addrs": ["crit"]}'

# Launch "file" service plugin
mqttwarn --plugin=file --options='{"message": "Hello world\n", "addrs": ["/tmp/mqttwarn.err"]}'

# Launch "pushover" service plugin
mqttwarn --plugin=pushover --options='{"title": "About", "message": "Hello world", "addrs": ["userkey", "token"], "priority": 6}'

# Launch "ssh" service plugin from the command line
mqttwarn --plugin=ssh --config='{"host": "", "port": 22, "user": "foo", "password": "bar"}' --options='{"addrs": ["command with substitution %s"], "payload": "{\"args\": \"\"}"}'

# Launch "cloudflare_zone" service plugin from "mqttwarn-contrib", passing "--config" parameters via command line
pip install mqttwarn-contrib
mqttwarn --config='{"auth-email": "foo", "auth-key": "bar"}' --options='{"addrs": ["0815", "", ""], "message": ""}'

Also, the --config-file parameter can be used to optionally specify the path to a configuration file.

Running as system daemon

Running in a development sandbox

For hacking on mqttwarn, please install it in development mode.


Thanks to all the contributors of mqttwarn who got their hands dirty with it and helped to co-create and conceive it in one way or another. You know who you are.

Project information


These links will guide you to the source code of mqttwarn and its documentation.


You’ll need at least the following components:

  • Python. The program should work on Python 3 and PyPy3.
  • An MQTT broker. We recommend Mosquitto.
  • Some more Python modules to satisfy service dependencies defined in the file.


We are always happy to receive code contributions, ideas, suggestions and problem reports from the community.

So, if you’d like to contribute you’re most welcome. Spend some time taking a look around, locate a bug, design issue or spelling mistake and then send us a pull request or create an issue.

Thanks in advance for your efforts, we really appreciate any help or feedback.


This software is copyright © 2014-2019 Jan-Piet Mens and contributors. All rights reserved.

It is and will always be free and open source software.

Use of the source code included here is governed by the Eclipse Public License 2.0, see LICENSE file for details. Please also recognize the licenses of third-party components.


If you encounter any problems during setup or operations or if you have further suggestions, please let us know by opening an issue on GitHub. Thanks already.




mqttwarn is currently undergoing some refurbishment and will also be ported to Python 3 during that phase. You are welcome to participate!

We outlined the tasks for the next releases within the backlog. They might be transferred into GitHub issues progressively, if applicable.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqttwarn-0.28.1.tar.gz (120.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page