Create heartbeat
create_heartbeatCreate a deadline monitor for a job, device or agent that should keep checking in. Call ping_heartbeat before the expected interval plus grace period ends. One missed deadline calls a public HTTPS webhook or wakes an active Agent Wake webhook task. The monitor lasts at most 24 hours from creation, and pings cannot extend that limit. The returned heartbeat ID and URLs are bearer secrets. No authentication is required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| on_miss | Yes | Exactly one miss target. Use url for a public HTTPS webhook, or wake_task_id for an active Agent Wake webhook task. | |
| grace_seconds | Yes | Extra time after the expected check-in before the miss action fires. | |
| expect_every_seconds | Yes | Expected time between check-ins, from 60 seconds to 24 hours. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| late | Yes | ||
| misses | Yes | ||
| status | Yes | ||
| on_miss | Yes | ||
| delivery | No | ||
| ping_url | Yes | ||
| ping_count | Yes | ||
| status_url | Yes | ||
| heartbeat_id | Yes | ||
| grace_seconds | Yes | ||
| missed_at_datetime | No | ||
| created_at_datetime | Yes | ||
| expires_at_datetime | Yes | ||
| missed_at_timestamp | No | ||
| created_at_timestamp | Yes | ||
| expect_every_seconds | Yes | ||
| expires_at_timestamp | Yes | ||
| miss_due_at_datetime | Yes | ||
| terminal_at_datetime | No | ||
| last_ping_at_datetime | Yes | ||
| miss_due_at_timestamp | Yes | ||
| terminal_at_timestamp | No | ||
| last_ping_at_timestamp | Yes | ||
| next_expected_at_datetime | Yes | ||
| next_expected_at_timestamp | Yes |