Signalgrid¶
Upstream docs: https://docs.signalgrid.co/api/push-api/
URL Format¶
signalgrid://client-key@channel[?title=title&type=type&critical=Yes]
URL Fields¶
- ClientKey - Signalgrid client key (Required)
URL part:signalgrid://clientkey@channel/ - Channel - Signalgrid channel token (Required)
URL part:signalgrid://clientkey@channel/
Query/Param Props¶
Props can be either supplied using the params argument or through the URL using
?key=value&key=value etc.
-
critical - Deliver as a critical alert Default: ❌
No -
title - Notification title Default: empty
-
type - Notification severity (CRIT, WARN, INFO, SUCCESS) Default:
INFOPossible values:INFO,WARN,SUCCESS,CRIT
Getting Started¶
- Create a Signalgrid account
- Copy your client key
- Copy a channel token
Basic notification
signalgrid://CLIENT_KEY@CHANNEL
Parameters¶
title: Optional notification title. Omitted from the API request when empty.type: Visual severity. One ofCRIT,WARN,INFO,SUCCESS(defaultINFO). Lowercase values such asinfoare accepted.critical: WhenYes/true, deliver as a critical alert that can bypass Do Not Disturb on supported devices.
type=CRIT does not enable critical delivery. Set critical=Yes separately.
Critical outage alert
signalgrid://CLIENT_KEY@CHANNEL?title=Server+Down&type=CRIT&critical=Yes