Notifiarr
| Schemes | notifiarr:// |
| Cargo feature | service-notifiarr |
| Service | https://notifiarr.com/ |
| Body formats | text (first is the default) |
| Attachments | no |
| Title length | 250 characters |
| Body length | 32,768 characters |
| Body lines | unlimited |
| Request throttle | 40 ms between requests |
| Vendor URLs accepted | no |
URL formats
{schema}://{apikey}/{targets}
{schema} is one of notifiarr://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{apikey} | Token | string | yes | secret | |
{target_channel} | Target Channel | string | no | prefix # | |
{targets} | Targets | list | yes | any of target_channel; separated by / |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
apikey | Token | string | sets {apikey}; also key | |
event | Discord Event ID | int | ||
image | Include Image | bool | no | |
source | Source | string | also from | |
to | Targets | list | sets {targets} |
The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.
Examples
Accepted URLs (tokens are fake):
notifiarr://apikey/1234
notifiarr://apikey/#1234/#5678
notifiarr://apikey/123?image=yes
notifiarr://apikey/123?event=1234
notifiarr://apikey/?to=123,%23456
notifiarr://123/?apikey=myapikey
notifiarr://apikey/123?source=My%20App
notifiarr://apikey/123?from=other&image=no
Rejected URLs:
notifiarr://
notifiarr://:@/
notifiarr://apikey/123?event=abc
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'notifiarr://apikey/1234'
Notes
Notifiarr (notifiarr://): notifications through the Notifiarr API.