Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added documentation for custom notifications #44

Merged
merged 1 commit into from
Dec 16, 2023
Merged

Added documentation for custom notifications #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,26 @@ All services require you to specify the phone number from and to:
| `NOTIFICATION_SMS_TWILIO` | Set to `true` |
| `NOTIFICATION_SMS_TWILIO_ACCOUNT_SID` | Twilio account SID |
| `NOTIFICATION_SMS_TWILIO_AUTH_TOKEN` | Twilio auth token |

## Custom Notifications

Both the up and down/degraded performance notifications can be customized with your preferred message, configured as an environment variable.
Multiple variables are available to use within the message, relating to the site and status.

### Environment Variables

| Value | Description |
| ---------------------------- | --------------------------------- |
| `NOTIFICATIONS_DOWN_MESSAGE` | Down/degraded performance message |
| `NOTIFICATIONS_UP_MESSAGE` | Up message |

### Message Variables

| Value | Example |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `$SITE_NAME` | Example Site |
| `$SITE_URL` | (https://example.koj.co) |
| `$ISSUE_URL` _(down message only)_ | https://github.com/upptime/upptime/issues/4 |
| `$RESPONSE_CODE` _(down message only)_ | 500 |
| `$STATUS` | <ul><li>**down**</li><li>experiencing **degraded performance**</li><li>is back up</li><li>performance has improved</li></ul> |
| `$EMOJI` | <ul><li>🟥</li><li>🟨</li><li>🟩</li></ul> |