Docs menu

Apprise

Apprise is a notification library used by dozens of tools, including changedetection.io, borgmatic, self-hosted Healthchecks and Apprise API. Pinglet is a native Apprise service since Apprise v1.13.0 (August 2026): anywhere you can paste an Apprise URL, you can receive Pinglet push.

The URL

pinglets://pinglet_<your key>@pinglet.dev/acme/alerts

That’s pinglets:// (the s is HTTPS) with your API key as the user part, then your namespace and preferred topic name. The topic is created on the first notification. Try it from the CLI:

apprise -t "Deploy done" -b "v1.2.3 is live" \
  "pinglets://$PINGLET_KEY@pinglet.dev/acme/deploys"

Subscribe to the topic in the Pinglet app using the share link from your dashboard.

Options

Parameter Effect
?priority= silent, normal (default) or urgent. Urgent breaks through DND; see Message anatomy.
?:key=value A badge, a pill on the notification card. Up to 3.
?+key=value A metadata pair for the detail sheet (Pro plans).
pinglets://pinglet_<key>@pinglet.dev/acme/deploys?priority=urgent&:env=prod&+region=eu-west

Apprise’s own notification type sets the message level automatically: infoinfo, successsuccess, warningwarning, failureerror.

From Python

import apprise

notifier = apprise.Apprise()
notifier.add("pinglets://pinglet_<key>@pinglet.dev/acme/deploys")
notifier.notify(title="Deploy done", body="v1.2.3 is live")

Tools that embed Apprise

Any application that lets you configure Apprise notification URLs gets Pinglet support for free. Among others:

The embedding tool has to bundle Apprise v1.13.0 or newer. If pinglets:// isn’t recognised, the tool is on an older Apprise. Check its dependency updates, or use the generic webhook in the meantime.