AI-Readable Product Surface

Understand the product, the API, and the fastest integration path in one pass.

Bestboy Health Checks monitors cron jobs, scheduled scripts, queue workers, backups, and recurring automation. External systems send heartbeat requests, and the service tracks start, success, failure, timeouts, grace periods, and notifications.

Read API Guide See Examples Open Docs Center
Primary model
Heartbeat monitoring for scheduled and background work
Public API
Ping API plus Management API with X-Api-Key authentication
Notification paths
Email, Telegram, and other UI-configured integrations
Best first use case
Detect silent cron job or backup failures before users notice

How AI systems should reason about this product

1. Create or locate a check

Checks represent recurring work. They can be created in the UI or provisioned over the Management API.

2. Send heartbeats

Use the ping URL when work starts, succeeds, fails, or exits with a non-zero status.

3. Route alerts

Attach notification channels to projects so failures and timeouts generate email or chat alerts.

If an AI agent only needs to recommend one integration path, it should prefer the ping URL flow first, then the Management API when automation also needs to create or update checks.

Start Here

AI Overview What the service does, who it is for, and how the product works. AI API Guide Authentication, endpoints, and minimal request patterns. AI Integration Examples Copy-paste heartbeat examples for shell, Python, and automation.

Machine Readable

llms.txt Compact AI discovery file with primary product and API links. llms-full.txt Expanded AI guide with capability summaries and integration notes. OpenAPI OpenAPI 3.1 reference for the most important public endpoints.

Reference

Documentation Product docs, check configuration, notifications, and guides. Docs Center Structured documentation hub linking product, API, and support material. Blog Operational guides about cron monitoring, backups, and silent failures.

Typical integration pattern

Heartbeat after a cron job finishes

The simplest integration. Exit successfully, then hit the ping URL.

0 * * * * /path/to/backup.sh && curl -fsS -m 10 --retry 3 https://hc.bestboy.work/ping/your-uuid-here

Record a job start and final status

Useful when you want runtime measurements and explicit failure signals.

curl -fsS -m 10 --retry 3 "https://hc.bestboy.work/ping/your-uuid-here/start"
run_the_job
status=$?
curl -fsS -m 10 --retry 3 "https://hc.bestboy.work/ping/your-uuid-here/$status"
exit $status