# Healthchecks

Bestboy Health Checks is a heartbeat monitoring service for cron jobs, scheduled scripts, queue workers, backups, CI tasks, and other recurring automation.

## Primary Product Model
- Users create checks that expect periodic pings.
- External systems send heartbeat requests to ping URLs.
- The service tracks start, success, failure, timeout, and grace periods.
- Notification channels include email and Telegram, with more integrations available in the UI.

## Best Starting Points
- AI Overview: https://hc.bestboy.work/ai/
- AI API Guide: https://hc.bestboy.work/ai/api/
- Integration Examples: https://hc.bestboy.work/ai/examples/
- OpenAPI: https://hc.bestboy.work/ai/openapi.json
- Docs Center: https://hc.bestboy.work/docs-center/
- Guides > Getting Started: https://hc.bestboy.work/docs-center/getting-started/
- Guides > Heartbeat API: https://hc.bestboy.work/docs-center/heartbeat-api/

## Common Integration Paths
- Cron or shell scripts: run the job, then call the ping URL with curl.
- CI systems: call /start before the job and /<exitstatus> after the job.
- Backend services: create and maintain checks through the Management API using X-Api-Key.

## Key Public URLs
- Homepage: https://hc.bestboy.work/
- Docs: https://hc.bestboy.work/docs/
- Blog: https://hc.bestboy.work/blog/
- Pricing: https://hc.bestboy.work/pricing/
- Terms: https://hc.bestboy.work/terms-and-conditions/

## Management API Summary
- Base paths: /api/v1/, /api/v2/, /api/v3/
- Authentication: X-Api-Key header
- Main resources: checks, channels, pings, flips, badges, metrics, status

## Heartbeat API Summary
- Success ping: /ping/<uuid>
- Start signal: /ping/<uuid>/start
- Failure signal: /ping/<uuid>/fail
- Exit-status signal: /ping/<uuid>/<exitstatus>
- Slug form: /ping/<ping_key>/<slug>

## Support
- Feedback email: stonestones2251132@gmail.com

## Notes for AI Agents
- Prefer the Guides menu and docs center for scenario-based questions.
- Prefer the ping API for simple external monitoring.
- Prefer the Management API when creating checks programmatically.
- Use the OpenAPI file and AI API page for request structure and examples.
- Use the docs center as the canonical navigation hub for product and integration docs.