Docs Center

A task-first documentation system for operators, builders, and AI agents.

Classic /docs/ remains available as the full reference. This newer layer reorganizes the product around concrete tasks: getting started, wiring heartbeats, using the Management API, validating alerts, and selecting the right monitoring pattern for a real job.

Open Product Docs Open AI Entry Browse Blog

Task Guides

Getting Started The fastest path from account setup to a working heartbeat and alert. Heartbeat API Public ping URLs for success, start, failure, and exit-status signaling. Management API Authenticated API for creating, updating, pausing, resuming, and inspecting checks. Notifications and Alerting How channels attach to projects and how to validate that alerts are actually delivered. Use Cases and Playbooks Task-oriented guidance for cron jobs, backups, CI, imports, and background workers.

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.

Quick-start recipes

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

Create a check over the Management API

Provision checks from your backend or automation scripts.

curl -X POST https://hc.bestboy.work/api/v3/checks/ \
  -H "X-Api-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Nightly backup",
    "slug": "nightly-backup",
    "tags": "ops backup",
    "timeout": 900,
    "grace": 300
  }'

Ping from Python

A tiny requests-based example for internal tools.

import requests

url = "https://hc.bestboy.work/ping/your-uuid-here"
response = requests.get(url, timeout=10)
response.raise_for_status()

How to use this layer

Use Guides first

Start here when the question is scenario-based: cron jobs, backups, CI, workers, or alert delivery.

Use AI pages second

Use the AI pages when you need a compressed product model, machine-readable links, or OpenAPI discovery.

Use classic Docs last

Use /docs/ as the full reference when you need the complete detail set or legacy topic coverage.