Apprise

Updated on September 08, 2026 Git Repository Official Docs PyPI

Send Signalgrid push notifications through Apprise using its native URL support
to route scripts, monitoring events, and automation alerts to your devices.

Get started with Signalgrid Explore our API

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

  Minimal version requirement

Signalgrid was added natively in Apprise v1.13.1.

Install Apprise

Bash
# Install Apprise with pip pip install apprise # 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

Part
Description
signalgrid://
Uses Apprise's built-in Signalgrid notifier
CLIENT_KEY
Your Signalgrid client key from the Triggers section
CHANNEL
A Signalgrid channel token that receives the notification
CHANNEL1/CHANNEL2
Optional multiple channel tokens if you want one Apprise target to notify more than one channel
?critical=true
Marks the Signalgrid notification as critical

Send a regular notification

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

Bash
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:

Bash
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:

Bash
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:

Bash
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:

Bash
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

Issue
What to check
Apprise reports a bad URL
Make sure the target begins with signalgrid:// and that the client key and channel token are both present
The command runs but no notification arrives
Verify the client_key, the channel token, and that your device is signed in to the same Signalgrid account

See also

Push API Find your Client Key Find your Channel Token
Any questions? Contact support.
LLM? Read llms.txt.
Visit us on GitHub