Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Notifiarr

Schemesnotifiarr://
Cargo featureservice-notifiarr
Servicehttps://notifiarr.com/
Body formatstext (first is the default)
Attachmentsno
Title length250 characters
Body length32,768 characters
Body linesunlimited
Request throttle40 ms between requests
Vendor URLs acceptedno

URL formats

{schema}://{apikey}/{targets}

{schema} is one of notifiarr://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{apikey}Tokenstringyessecret
{target_channel}Target Channelstringnoprefix #
{targets}Targetslistyesany of target_channel; separated by /

Query parameters

ParameterMeaningTypeDefaultNotes
apikeyTokenstringsets {apikey}; also key
eventDiscord Event IDint
imageInclude Imageboolno
sourceSourcestringalso from
toTargetslistsets {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.