Improvements for haven-notify
Some checks failed
Check scripts syntax / check-scripts-syntax (push) Successful in 1m19s
Haven Notify Build and Deploy / Build Haven Notify Image (push) Failing after 1m51s
Haven Notify Build and Deploy / Deploy Haven Notify (internal) (push) Successful in 33s

This commit is contained in:
2025-08-21 21:11:22 -03:00
parent 7520d70ce9
commit 100262513b
5 changed files with 201 additions and 41 deletions

View File

@@ -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