Skip to content

Commit 2d3f9ef

Browse files
committed
[Apprise] Improve documentation about propagating plugin parameters
1 parent a8307fa commit 2d3f9ef

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

HANDBOOK.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -554,11 +554,29 @@ XBMC, Vonage, Webex Teams.
554554
80+ notification services supported by Apprise.
555555
556556
Notification services are addressed by URL, see [Apprise URL Basics].
557-
Please consult the Apprise documentation about more details.
557+
Please consult the [Apprise documentation] about more details.
558+
559+
Apprise notification plugins obtain different kinds of configuration or
560+
template arguments. mqttwarn supports propagating them from either the
561+
``baseuri`` configuration setting, or from its data dictionary to the Apprise
562+
plugin invocation.
563+
564+
So, for example, you can propagate parameters to the [Apprise Ntfy plugin]
565+
by either pre-setting them as URL query parameters, like
566+
```
567+
ntfy://user:password@ntfy.example.org/topic1/topic2?email=test@example.org
568+
```
569+
or by submitting them within a JSON-formatted MQTT message, like
570+
```json
571+
{"priority": "high", "tags": "foo,bar", "click": "https://httpbin.org/headers"}
572+
```
573+
558574
559575
[Apprise]: https://github.com/caronc/apprise
576+
[Apprise documentation]: https://github.com/caronc/apprise/wiki
560577
[Apprise URL Basics]: https://github.com/caronc/apprise/wiki/URLBasics
561578
[Apprise Notification Services]: https://github.com/caronc/apprise/wiki#notification-services
579+
[Apprise Ntfy plugin]: https://github.com/caronc/apprise/wiki/Notify_ntfy
562580
563581
564582
### `apprise_single`

0 commit comments

Comments
 (0)