Ping a heartbeat by slug, creating it on first ping

GET

/hb/auto/{slug}

• Production

The one-line provisioning path. If no heartbeat with this slug exists it is created (respecting plan limits, bound to the account’s default escalation policy) and the ping is recorded; if it exists, the ping is recorded. interval, grace, name, and region apply only at creation, so configuration cannot drift ping by ping.

curl -fsS -H "X-API-Key: $ALERTKICK_API_KEY" \
  "https://acme.alertkick.com/api/v1/hb/auto/nightly-backup?interval=86400&grace=3600"

For long-lived jobs, prefer fetching the heartbeat’s scoped api_key afterwards and pinging /hb/ping/{uuid} with it, so the account key does not live in the crontab.

Authorizations

• apiKey

Parameters

Path Parameters

slug

required

string

/^[a-zA-Z0-9][a-zA-Z0-9._-]{0,63}$/

Example

nightly-backup

Query Parameters

interval

integer

default: 86400 >= 60 <= 31536000

Expected seconds between pings (creation only).

grace

integer

default: 3600 >= 60 <= 31536000

Grace period in seconds (creation only).

name

string

Display name (creation only; defaults to the slug).

Responses

200

Ping recorded against an existing heartbeat.

object

message

string

Example

pong

status

string

Example

ok

uuid

string

Example

d1nq8sg44a5g5h3k2b7g

slug

string

Example

nightly-backup

created

True when this request created the heartbeat.

boolean

201

Heartbeat created and first ping recorded.

object

message

string

Example

pong

status

string

Example

ok

uuid

string

Example

d1nq8sg44a5g5h3k2b7g

slug

string

Example

nightly-backup

created

True when this request created the heartbeat.

boolean

401

Missing or invalid API key.

object

error

string

message

string

key

additional properties

any

402

Plan limit reached — upgrade to add more.

object

error

string

message

string

key

additional properties

any