Notifications and alerts

Get told when a deploy fails, a backup does not run, a server goes offline, or an API token is created.

Get told when something happens: a deploy failed, a backup did not run, a server went offline, somebody created an API token.

Two parts, configured separately:

  • A channel is where a message is sent. There are twelve kinds, and you can have as many of each as you like.
  • Each channel has its own alert selection. A team chat room can receive every deployment result while an on-call phone receives only failures.

A new channel starts with sensible defaults.

Channels

The alert channels of a team, each with its own on/off The Add a channel dialog with every channel kind

Settings -> Notifications, then add a channel.

KindWhat it needs
Discord, WebhookAn incoming webhook URL
Slack, Mattermost, Microsoft Teams, LarkAn incoming webhook URL. Beta
TelegramA bot token and a chat id. Beta
EmailYour own SMTP server, or a Resend API key
ntfy, Gotify, PushoverThe service's URL and token. Beta
Browser pushPermission from your browser. Beta

Each channel has a test button. Credentials are write-only: a field left blank when you save keeps what is already stored.

Pick what each channel is told about

Open the channel's alert picker. It has a search box and a category list, like the role editor. The 37 alerts are grouped in nine categories:

CategoryExamples
DeploymentsDeployment failed, Deployment succeeded, Deployment interrupted, Git connection stopped working, Deplo lost access to a repository
AppsApp keeps restarting, App ran out of memory
Cron jobsCron job failed, Cron job finished
DatabasesDatabase ready, Database setup failed, Database rebuilt, Database deleted
Backups & restoreBackup failed, Backup finished, Restore finished, Restore failed
ServersServer offline, Server back online, Server running hot, Server disk almost full, Server cannot run apps, Server identity changed, Server agent certificate not renewed, Cleanup failed, Leftover containers
This Deplo instanceA new Deplo version is available
Security & teamAPI token created, API token revoked, Member joined, Member removed, Member access changed, Team owner changed, Two-factor requirement changed, Repeated failed sign-ins
Domains & TLSCertificate expiring, Domain points elsewhere

Unselect all and Reset to defaults are both available.

Alerts are not the activity trail

  • An alert interrupts. It goes to a channel right away, because somebody should look.
  • The activity trail is looked up later. It answers "who did this and when" in the Activity page. It is never delivered anywhere.

Good to know

  • Every webhook URL must be public HTTPS. Addresses inside your own network are refused, for security reasons. A Gotify or ntfy on the LAN does not work.
  • Every alert in the list is real. None of them is a switch that never fires.
  • Notification settings are per team. Another team's failures go to their channels.
  • manage_notifications is the capability.

Troubleshooting

SymptomWhat to check
The test succeeds and real alerts never arriveThat channel's alert selection does not include them. Open its picker.
The test failsThe message names the cause: a rejected certificate, a refused connection, a name that does not resolve.
Saving a channel is refusedThe URL is not public HTTPS, or it resolves to a private address.
Email never arrivesCheck the SMTP host, port and credentials, and whether your provider requires a verified sender address.

Next steps

Did this page help you?

On this page