Apprise

Prerequisites

• An Apprise installation on the system that will send notifications
• A Signalgrid account
• Your Signalgrid client_key
• One or more target channel tokens
• Outbound HTTPS access to Signalgrid

Install Apprise

Install Apprise with pip:

pip install apprise

After installation, verify the CLI is available:

apprise --version

You will need your Signalgrid client key and a channel token before using Apprise.
If you need help locating them, see Find your Client Key and Find your Channel Token.

Signalgrid URL Format

Apprise supports the following URL formats for Signalgrid

signalgrid://CLIENT_KEY/CHANNEL
signalgrid://CLIENT_KEY/CHANNEL1/CHANNEL2
signalgrid://CLIENT_KEY/CHANNEL?critical=true

Parameters

Send a regular notification

Once you have your client key and channel token, send a first test notification like this:

apprise -vv \
  -t "Deployment finished" \
  -b "Version 2.4.0 is now live." \
  "signalgrid://YOUR_CLIENT_KEY/YOUR_CHANNEL_TOKEN"

The Apprise title becomes the Signalgrid notification title, and the Apprise body becomes the Signalgrid notification body.

Notify Multiple Channels

If you want the same event to appear in more than one Signalgrid channel, add more channel tokens to the URL:

apprise \
  -t "Nightly job finished" \
  -b "Backups and cleanup completed successfully." \
  "signalgrid://YOUR_CLIENT_KEY/CHANNEL_ALPHA/CHANNEL_BETA"

Send a critical notification

If you want one Apprise target that always creates urgent Signalgrid alerts, append ?critical=true to the Signalgrid URL:

apprise \
  -t "Server down" \
  -b "The primary web node is not responding." \
  "signalgrid://YOUR_CLIENT_KEY/YOUR_CHANNEL_TOKEN?critical=true"

This is useful for host-down alerts, failed backups, and other events that should bypass quiet modes on supported devices.

Manual Testing

When you test the integration for the first time, keep the command simple and run it with verbose output:

apprise -vv \
  -t "Signalgrid test" \
  -b "Apprise reached Signalgrid successfully." \
  "signalgrid://YOUR_CLIENT_KEY/YOUR_CHANNEL_TOKEN"

If the notification does not show up, compare the result with a direct Signalgrid API request from the same machine:

curl -X POST https://api.signalgrid.co/v1/push \
    -d "client_key=YOUR_CLIENT_KEY" \
    -d "channel=YOUR_CHANNEL_TOKEN" \
    -d "title=Signalgrid direct test" \
    -d "body=cURL reached Signalgrid successfully"

Troubleshooting