Heartbeats

Create Heartbeat

Create a new heartbeat for the active organization.

post/v1/heartbeats

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/heartbeats
  • Auth: API key in header Authorization

Headers

X-Organization-Idstring uuid nullable

Request body

namestring required
period_secondsinteger required
grace_secondsinteger required
notification_cooldown_secondsinteger nullable
channel_idsstring[] nullable
tagsstring[]

Response

Successful Response

idstring uuid required
namestring required
state'PENDING' | 'UP' | 'DOWN' | 'PAUSED' required

Lifecycle state of a heartbeat.

PENDING — created, never pinged; the sweep skips it (overdue_at is NULL) so a freshly created heartbeat does not false-alarm. UP — pinged within period + grace; the only state the sweep can flip to DOWN. DOWN — a ping was missed or the job sent /fail; an incident is open. PAUSED — owner-paused; inactive, never alerts.

period_secondsinteger required
grace_secondsinteger required
ping_urlstring required
last_ping_atstring date-time nullable required
last_success_atstring date-time nullable required
last_start_atstring date-time nullable required
last_duration_msinteger nullable required
overdue_atstring date-time nullable required
notification_cooldown_secondsinteger required
is_activeboolean required
channel_idsstring[]
tagsstring[]
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.