Improvements for haven-notify
This commit is contained in:
@@ -3,12 +3,12 @@
|
||||
## Overview
|
||||
Haven Notify is an internal service designed to send notifications to a specified Discord channel.
|
||||
|
||||
It is built in Go and can be deployed as a container or managed service.
|
||||
It's built in Go and can be deployed as a container or managed service.
|
||||
|
||||
## Prerequisites
|
||||
- Go 1.18 or newer (for local development)
|
||||
- Docker (for containerized deployment)
|
||||
- Discord Webhook URL
|
||||
- Go 1.18 or newer
|
||||
- Docker
|
||||
- A Discord Webhook URL
|
||||
|
||||
## API Specification
|
||||
|
||||
@@ -23,6 +23,23 @@ It is built in Go and can be deployed as a container or managed service.
|
||||
}
|
||||
```
|
||||
|
||||
- **Endpoint**: `/template/notify/backup_template`
|
||||
- **Method**: `POST`
|
||||
- **Request Body**:
|
||||
```json
|
||||
{
|
||||
"title": "Notification Title",
|
||||
"message": "Notification Message",
|
||||
"backupSizeInMB": 500,
|
||||
"extra": [
|
||||
{
|
||||
"name": "Additional Info",
|
||||
"value": "Some extra information"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Setup & Usage
|
||||
|
||||
### Docker
|
||||
|
Reference in New Issue
Block a user