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.
URLs are configured in settings (Settings > Notifications). Alerts are enabled in the systems table.
Services overview
Click on the service for a more thorough explanation.
| Service | URL format |
|---|---|
| Generic | generic://example.com?template=json |
| Bark | bark://devicekey@host |
| Discord | discord://token@id |
| Gotify | gotify://gotify-host/token |
| Google Chat | googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz |
| IFTTT | ifttt://key/?events=event1[,event2,...]&value1=value1&value2=value2&value3=value3 |
| Join | join://shoutrrr:api-key@join/?devices=device1[,device2, ...][&icon=icon] |
| Lark | lark://host/token?secret=secret |
| Mattermost | mattermost://[username@]mattermost-host/token[/channel] |
| Matrix | matrix://username:password@host:port/[?rooms=!roomID1[,roomAlias2]] |
| Ntfy | ntfy://:accesstoken@host/topic |
| OpsGenie | opsgenie://host/token?responders=responder1[,responder2]_ |
| Pushbullet | pushbullet://api-token[/device/#channel/email] |
| Pushover | pushover://shoutrrr:apiToken@userKey/?devices=device1[,device2, ...] |
| Rocketchat | rocketchat://[username@]rocketchat-host/token[/channel|@recipient] |
| Signal | signal://[user[:password]@]host[:port]/source_phone/recipient1[,recipient2,...] |
| Slack | slack://[botname@]token-a/token-b/token-c |
| Teams | teams://group@tenant/altId/groupOwner/extraId?host=organization.webhook.office.com |
| Telegram | telegram://token@telegram?chats=@channel-1[,chat-id-1,...] |
| WeCom | wecom://key |
| Zulip Chat | zulip://bot-mail:bot-key@zulip-domain/?stream=name-or-id&topic=name |