Get a heartbeat monitor
get_heartbeatRead one heartbeat to check a job's state, last run duration, and next due time so you can confirm whether it ran and when it will be reported late.
Instructions
Read one heartbeat in full, including how long its last run took. It has name, state, period_seconds, grace_seconds, ping_url, last_ping_at, last_success_at, last_start_at, last_duration_ms (how long the last run took, from its /start to its success ping), overdue_at (when it will be reported late), notification_cooldown_seconds, is_active, channel_ids and tags. Use it to answer whether a job ran, how long it took and when it is next due. To find a heartbeat use list_heartbeats; to change it use update_heartbeat; probed monitors are get_monitor.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| heartbeat_id | Yes | The heartbeat's uuid from list_heartbeats. An id that is not a heartbeat of this organization, or a deleted one, is a 404. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| tags | No | ||
| state | Yes | Known values: PENDING, UP, DOWN, PAUSED. | |
| ping_url | Yes | ||
| is_active | Yes | ||
| created_at | Yes | ||
| overdue_at | Yes | ||
| updated_at | Yes | ||
| channel_ids | No | ||
| last_ping_at | Yes | ||
| grace_seconds | Yes | ||
| last_start_at | Yes | ||
| period_seconds | Yes | ||
| last_success_at | Yes | ||
| last_duration_ms | Yes | ||
| notification_cooldown_seconds | Yes |