Skip to content

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: INFO Possible values: INFO, WARN, SUCCESS, CRIT

Getting Started

  1. Create a Signalgrid account
  2. Copy your client key
  3. 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 of CRIT, WARN, INFO, SUCCESS (default INFO). Lowercase values such as info are accepted.
  • critical: When Yes/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