Skip to main content

Apprise

The apprise trigger sends notifications via Apprise, unlocking delivery to 80+ notification services including Matrix, Signal, Nextcloud, Line, and more.

⚙️ Configuration Variables​

WUD_TRIGGER_APPRISE_{trigger_name}_URL
Requiredurl

Base URL of the Apprise API server

Allowed values:Valid HTTP/HTTPS URL
WUD_TRIGGER_APPRISE_{trigger_name}_CONFIG
Optionalstring

Name of an Apprise YAML configuration file

Allowed values:[Apprise persistent configuration documentation](https://github.com/caronc/apprise/wiki/config_yaml)
WUD_TRIGGER_APPRISE_{trigger_name}_TAG
Optionalstring

Optional tag(s) to match when using an Apprise YAML configuration

Allowed values:[Apprise persistent configuration documentation](https://github.com/caronc/apprise/wiki/config_yaml)
WUD_TRIGGER_APPRISE_{trigger_name}_URLS
Optionalstring

Comma-separated list of Apprise service notification URLs

Allowed values:[Supported Apprise notification URLs](https://github.com/caronc/apprise#popular-notification-services)
info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

🚀 Examples​

Send an Email and SMS via Apprise​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_APPRISE_LOCAL_URL=http://apprise:8000
      - WUD_TRIGGER_APPRISE_LOCAL_URLS=mailto://john.doe:secret@gmail.com,sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+1(800)555-1223

Use Persistent YAML Configuration​

Declare an Apprise YAML configuration (see docs), such as wud.yml:

# wud.yml example
urls:
  - tgram://{bot_token}/{chat_id}:
      - tag: devops
services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_APPRISE_LOCAL_URL=http://apprise:8000
      - WUD_TRIGGER_APPRISE_LOCAL_CONFIG=wud # name of the YAML config file
      - WUD_TRIGGER_APPRISE_LOCAL_TAG=devops # tag filter for the config (optional)

📖 Setup Guide: Running the Apprise API Server​

Run the official Apprise Docker image. For more details, see the official Apprise API documentation.

services:
  apprise:
    image: caronc/apprise
    container_name: apprise
    ports:
      - "8000:8000"