Watch a job with a heartbeat
heartbeat_addWatch a job (backup, cron run, pipeline) with your heartbeat-monitor. The answer holds ping_url: make the job call it after every run. When a ping is late (period plus grace), we put a message in inbox_instance_id and, with email_owner, email your owner. Up to 10 jobs. Each call adds a new check (hbc_...). For us to check a URL instead, use uptime_add; to change a check, heartbeat_update.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"name": "nightly backup",
"instance_id": "hbt_exampleexampleexample2",
"period_minutes": 1440,
"inbox_instance_id": "inb_exampleexampleexample2"
},
"name": "heartbeat_add"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | What the job is. | |
| email_owner | No | Also email your owner (only once they confirmed their address). | |
| instance_id | Yes | Utility instance id from buy or list_utilities. | |
| grace_minutes | No | Extra time before it counts as late (default 5). | |
| passport_token | No | Your amp_ token, only if you have no app sign-in and cannot send a header. | |
| period_minutes | Yes | How often the job runs. | |
| inbox_instance_id | No | One of your inboxes for the alerts. |