跳至內容

Apprise

只要一個 pushward:// URL,就能從任何以 Apprise 為基礎的 App 傳送通知到 PushWard。

⚠ 警告

PushWard needs Apprise 1.12.0 or later. An app that bundles an older Apprise will not recognise a pushward:// URL.

Get Your Integration Key

使用您在 PushWard App 的 設定 → 整合金鑰中的預設整合金鑰,或為此整合建立範圍受限的金鑰。

The key needs notifications at send (permissions).

The URL

Apprise URL
pushward://hlk_YOUR_INTEGRATION_KEY

Try it from the Apprise command line before pasting it into an app:

Test with the Apprise CLI
apprise -vv -t "Backup finished" -b "Copied 12 GB to the NAS" \
  "pushward://hlk_YOUR_INTEGRATION_KEY"

Apprise file attachments are not sent. A message with no title is titled with the sending app's Apprise description, which is "Apprise Notifications" unless the app sets its own.

Notification levels

Every Apprise message has a type, and the type picks the PushWard interruption level.

Apprise typeURL optionDefault level
Infoinfoactive
Successsuccessactive
Warningwarningtime-sensitive
Failurefailuretime-sensitive

Each option takes passive, active, time-sensitive or critical, so you can change one type and leave the rest:

Quiet info, critical failures
pushward://hlk_YOUR_INTEGRATION_KEY?info=passive&failure=critical

level takes the same four values and wins over the table: every message gets that level, whatever its type.

Every message critical, at 80% volume
pushward://hlk_YOUR_INTEGRATION_KEY?level=critical&volume=0.8

volume runs from 0.0 to 1.0 and only applies to a message that ends up critical. Nothing is critical unless you ask for it, because it breaks through silent mode and Focus. The device also has to have allowed Critical Alerts.

Apps that take Apprise URLs

Anywhere an app asks for an Apprise URL, give it the one above. Three examples:

  • changedetection.io: add it to a watch's notification URLs on its edit tab.
  • Moonraker (Klipper): set it as url in a [notifier my_phone] section. Moonraker writes the Apprise version it has installed to moonraker.log, which is the quick way to check the 1.12.0 requirement.
  • NetAlertX: put it in APPRISE_URL. NetAlertX hands it to the separate Apprise container you point APPRISE_HOST at, so that container is the one that needs 1.12.0.