ronaldo/health-check
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: documentar exibição do body nas notificações do Telegram

Browse source 
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
SantosFC 2026-06-08 13:32:46 -03:00 committed by GitHub
parent 64925ffe5b
commit ea975898b0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/ping-payload.md
View file

@ -104,3 +104,30 @@ ping(url, agent="my-bot", device="server", timeout=5)
## Failure Ping
On error, agents must send a POST to `<uuid>/fail` with the same body. The `ping_fail` function handles this automatically.
---
## Telegram Notifications
Healthchecks.io includes the ping body as **Last Ping Body** in Telegram notifications (UP, DOWN, and failure events). The body is displayed as raw JSON with syntax highlighting.
Example of what appears in the Telegram message:
```
🟢 The check mySoccer is now UP.
Project: FastAPI
Tags: Telegram, Soccer
Period: 2 minutes
Total Pings: 860
Last Ping: Success, a second ago
Last Ping Body:
{"user":"ronaldo","device":"sandbox","ips":["192.168.122.71","fe80::f9f:d854:2bed:e454","100.70.8.112"],"uptime":"0d 2h 47m"}
```
### Implications for payload design
- Keep field names short and meaningful — they appear directly in the notification
- `user` identifies who sent the ping (agent name)
- `device` and `uptime` give immediate context for diagnosing incidents without leaving Telegram
- Avoid sensitive data in the body (IPs are acceptable; avoid tokens or passwords)