PulseGuard docs

Public reference for the trial: authentication, intervals, timeouts, Telegram alerts, and minimal curl examples. No login required to read this page.

Authentication

Creating a probe issues a Bearer token once (shown only at create time). The server stores a hash, not the raw token. Heartbeat calls must send:

Authorization: Bearer <token>

Missing or wrong tokens return 401 and do not update last_seen.

Heartbeat interval

Interval is the expected cadence you plan to ping (for example every 60 seconds). Use cron, a worker loop, or your monitor to POST on that schedule. Interval is guidance for operators; enforcement is the timeout threshold below.

Timeout threshold

If no successful heartbeat arrives within timeout seconds, the probe is treated as timed out. A background checker runs about every minute; in practice alerts fire within minutes of silence (not a hard SLA). Timeout should be greater than or equal to your interval.

Alerts (Telegram)

Trial alerts go to Telegram. Configure bot token + chat id via environment (or settings API). Creating a probe is blocked until an alert channel is configured— no silent failure.

On timeout, one alert is sent until the probe recovers (heartbeat resumes).

Minimal examples

Heartbeat once:

curl -X POST \
  -H "Authorization: Bearer <token>" \
  https://pulseguard.agentbuff.dev/api/heartbeat

Cron every minute:

* * * * * curl -fsS -X POST \
  -H "Authorization: Bearer <token>" \
  https://pulseguard.agentbuff.dev/api/heartbeat

Next: open the console · dead man switch monitoring · heartbeat watchdog

FAQ

How do I authenticate heartbeats?

Send a Bearer token with each heartbeat request. Create probes in the console to get credentials and intervals.

What timeout should I use?

Pick a timeout longer than your job’s normal interval plus slack. If heartbeats miss that window, Telegram alerts fire.

Can I call the API from cron?

Yes. Use curl or any HTTP client on a schedule to POST heartbeats. See the curl examples on this docs page.

Do I need an App to get alerts?

No App is required for the trial. Configure Telegram in settings and keep heartbeats flowing from your jobs.