Skip to content

Notifications

Notifications in Beszel are defined using Shoutrrr URL schemas.

Shoutrrr is a Go library originally developed for use in Watchtower. We use a pinned version of a maintained fork, nicholas-fedor/shoutrrr. The docs here are adapted from there.

Services overview

Click on the service for a more thorough explanation.

ServiceURL format
Genericgeneric://example.com?template=json
Barkbark://devicekey@host
Discorddiscord://token@id
Gotifygotify://gotify-host/token
Google Chatgooglechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz
IFTTTifttt://key/?events=event1[,event2,...]&value1=value1&value2=value2&value3=value3
Joinjoin://shoutrrr:api-key@join/?devices=device1[,device2, ...][&icon=icon]
Larklark://host/token?secret=secret
Mattermostmattermost://[username@]mattermost-host/token[/channel]
Matrixmatrix://username:password@host:port/[?rooms=!roomID1[,roomAlias2]]
Ntfyntfy://username:password@ntfy.sh/topic
OpsGenieopsgenie://host/token?responders=responder1[,responder2]_
Pushbulletpushbullet://api-token[/device/#channel/email]
Pushoverpushover://shoutrrr:apiToken@userKey/?devices=device1[,device2, ...]
Rocketchatrocketchat://[username@]rocketchat-host/token[/channel|@recipient]
Slackslack://[botname@]token-a/token-b/token-c
Teamsteams://group@tenant/altId/groupOwner?host=organization.webhook.office.com
Telegramtelegram://token@telegram?chats=@channel-1[,chat-id-1,...]
Zulip Chatzulip://bot-mail:bot-key@zulip-domain/?stream=name-or-id&topic=name

Released under the MIT License