Skip to content


URL Format

join://shoutrrr:api-key@join/?devices=device1[,device2, ...][&icon=icon][&title=title]

URL Fields

  • APIKey (Required)
    URL part: join://:apikey@join/

Query/Param Props

Props can be either supplied using the params argument, or through the URL using
?key=value&key=value etc.

  • Devices - Comma separated list of device IDs (Required)

  • Icon - Icon URL
    Default: empty

  • Title - If set creates a notification
    Default: empty


  1. Go to the Join Webapp
  2. Select your device
  3. Click Join API
  4. Your deviceId is shown in the top
  5. Click Show next to API Key to see your key
  6. Your Shoutrrr URL will then be: join://shoutrrr:api-key@join/?devices=deviceId

Multiple deviceIds can be combined with a , (repeat steps 2-4).