Healthchecks.io

App · 11 actions

Monitor cron jobs and scheduled tasks with Healthchecks.io: create, change, pause and delete checks, ping them when a job runs, and read their pings and outages. Start a workflow when a check goes down or comes back up.

Actions

ActionWhat it does
Change checkChange a check's name, tags, description, period or schedule, grace time or alerts.
Create checkCreate a check that expects a ping on a period or a schedule, and get its ping address.
Delete checkDelete a check and its history.
Get checkGet one check: its status, last and next ping, schedule and ping address.
List checksList the project's checks with their status and last ping, down ones first.
List integrationsList the project's integrations: the email addresses, chats and apps alerts go to.
List pingsList the pings a check received, newest first, with their kind and where they came from.
List status changesList when a check went down and came back up, newest first.
Pause checkPause a check, such as during maintenance, so it sends no alerts until it is pinged again.
Ping checkTell Healthchecks.io a job succeeded, started or failed, or just log a message on the check, the way a cron job would.
Resume checkResume a paused check, so it alerts again when a ping is late.

Change check

Change a check's name, tags, description, period or schedule, grace time or alerts.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.
Namenametext
A new name. Leave empty to keep it.
Tagstagslist
Its tags, replacing the ones it has. Leave empty to keep them.
Descriptiondescriptiontext
What the check is for. Leave empty to keep it.
Expect a ping every (minutes)period_minutesnumber
How often the job runs, such as 60 for hourly. Leave empty to keep it.From 1 to 525600.
Or on a schedulescheduletext
Instead of a period, a cron expression such as 0 3 * * * (3am daily).
Schedule time zonetime_zonetext
The time zone the schedule is in, such as Europe/London. Defaults to UTC.
Grace time (minutes)grace_minutesnumber
How late a ping may be before the check goes down. Leave empty to keep it.From 1 to 525600.
Alert throughintegrationslist
The integrations to alert when it goes down. Leave empty to keep it.

Outputs

badge_urltext
Its status badge
descriptiontext
Its description
grace_minutesnumber
How late a ping may be before it goes down
integrationslist
The integrations it alerts
last_pingtext
When it last got a ping (ISO 8601); empty if never
nametext
Its name
next_pingtext
When the next ping is due (ISO 8601); empty if not known
period_minutesnumber
How often a ping is expected; empty for a scheduled check
ping_urltext
The address the job pings
pingsnumber
How many pings it has had
scheduletext
Its cron or OnCalendar schedule; empty for a period check
slugtext
Its slug
startedtrue/false
True while a job that sent a start signal runs
statustext
new, up, grace (late), down or paused
tagslist
Its tags
time_zonetext
The schedule's time zone
uuidtext
The check's UUID
Example output
{
  "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
  "description": "Runs ~/backup.sh",
  "grace_minutes": 60,
  "integrations": [
    "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
  ],
  "last_ping": "2026-10-27T03:00:12+00:00",
  "name": "Nightly backup",
  "next_ping": "2026-10-28T03:00:12+00:00",
  "period_minutes": null,
  "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
  "pings": 42,
  "schedule": "0 3 * * *",
  "slug": "nightly-backup",
  "started": false,
  "status": "up",
  "tags": [
    "backup",
    "prod"
  ],
  "time_zone": "Europe/London",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Create check

Create a check that expects a ping on a period or a schedule, and get its ping address. It can update a check of the same name instead.

Inputs

NamenametextRequired
What the check watches, such as Nightly backup.
Slugslugtext
A short name for pinging by slug: a-z, 0-9, '-' and '_'.
Tagstagslist
Tags to group it by.
Descriptiondescriptiontext
What the check is for.
Expect a ping every (minutes)period_minutesnumber
How often the job runs, such as 60 for hourly. Defaults to a day.From 1 to 525600.
Or on a schedulescheduletext
Instead of a period, a cron expression such as 0 3 * * * (3am daily).
Schedule time zonetime_zonetext
The time zone the schedule is in, such as Europe/London. Defaults to UTC.
Grace time (minutes)grace_minutesnumber
How late a ping may be before the check goes down. Defaults to an hour.From 1 to 525600.
Alert throughintegrationslist
The integrations to alert when it goes down.
Update if it existsupdate_if_existstrue/false
Change the check with this name instead of making a second one. Off by default.Default: false.

Outputs

badge_urltext
Its status badge
descriptiontext
Its description
grace_minutesnumber
How late a ping may be before it goes down
integrationslist
The integrations it alerts
last_pingtext
When it last got a ping (ISO 8601); empty if never
nametext
Its name
next_pingtext
When the next ping is due (ISO 8601); empty if not known
period_minutesnumber
How often a ping is expected; empty for a scheduled check
ping_urltext
The address the job pings
pingsnumber
How many pings it has had
scheduletext
Its cron or OnCalendar schedule; empty for a period check
slugtext
Its slug
startedtrue/false
True while a job that sent a start signal runs
statustext
new, up, grace (late), down or paused
tagslist
Its tags
time_zonetext
The schedule's time zone
uuidtext
The check's UUID
Example output
{
  "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
  "description": "Runs ~/backup.sh",
  "grace_minutes": 60,
  "integrations": [
    "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
  ],
  "last_ping": "",
  "name": "Nightly backup",
  "next_ping": "",
  "period_minutes": null,
  "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
  "pings": 0,
  "schedule": "0 3 * * *",
  "slug": "nightly-backup",
  "started": false,
  "status": "new",
  "tags": [
    "backup",
    "prod"
  ],
  "time_zone": "Europe/London",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Delete check

Delete a check and its history. It cannot be undone.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.

Outputs

deletedtrue/false
True once deleted
nametext
Its name
uuidtext
The deleted check's UUID
Example output
{
  "deleted": true,
  "name": "Nightly backup",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Get check

Get one check: its status, last and next ping, schedule and ping address.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.

Outputs

badge_urltext
Its status badge
descriptiontext
Its description
grace_minutesnumber
How late a ping may be before it goes down
integrationslist
The integrations it alerts
last_pingtext
When it last got a ping (ISO 8601); empty if never
nametext
Its name
next_pingtext
When the next ping is due (ISO 8601); empty if not known
period_minutesnumber
How often a ping is expected; empty for a scheduled check
ping_urltext
The address the job pings
pingsnumber
How many pings it has had
scheduletext
Its cron or OnCalendar schedule; empty for a period check
slugtext
Its slug
startedtrue/false
True while a job that sent a start signal runs
statustext
new, up, grace (late), down or paused
tagslist
Its tags
time_zonetext
The schedule's time zone
uuidtext
The check's UUID
Example output
{
  "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
  "description": "Runs ~/backup.sh",
  "grace_minutes": 60,
  "integrations": [
    "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
  ],
  "last_ping": "2026-10-27T03:00:12+00:00",
  "name": "Nightly backup",
  "next_ping": "2026-10-28T03:00:12+00:00",
  "period_minutes": null,
  "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
  "pings": 42,
  "schedule": "0 3 * * *",
  "slug": "nightly-backup",
  "started": false,
  "status": "up",
  "tags": [
    "backup",
    "prod"
  ],
  "time_zone": "Europe/London",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

List checks

List the project's checks with their status and last ping, down ones first.

Inputs

Tagstagslist
Only checks with all of these tags.
Statusstatustext
Only checks in this state. Defaults to any.One of: any (Any status), down, grace (Late (in its grace period)), up, paused, new (New (never pinged)), started (Started (running now)). Default: any.
Slugslugtext
Only the check with this slug.

Outputs

checkslist
The checks
countnumber
How many checks
down_countnumber
How many are down
Example output
{
  "checks": [
    {
      "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
      "description": "Runs ~/backup.sh",
      "grace_minutes": 60,
      "integrations": [
        "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
      ],
      "last_ping": "2026-10-27T03:00:12+00:00",
      "name": "Nightly backup",
      "next_ping": "2026-10-28T03:00:12+00:00",
      "period_minutes": null,
      "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
      "pings": 42,
      "schedule": "0 3 * * *",
      "slug": "nightly-backup",
      "started": false,
      "status": "up",
      "tags": [
        "backup",
        "prod"
      ],
      "time_zone": "Europe/London",
      "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
    }
  ],
  "count": 1,
  "down_count": 0
}

List integrations

List the project's integrations: the email addresses, chats and apps alerts go to.

Inputs

None.

Outputs

countnumber
How many integrations
integrationslist
The integrations
Example output
{
  "count": 1,
  "integrations": [
    {
      "id": "4ec5a071-2d08-4baa-898a-eb4eb3cd6941",
      "kind": "email",
      "name": "Ops email"
    }
  ]
}

List pings

List the pings a check received, newest first, with their kind and where they came from.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.
How manylimitnumber
How many pings, newest first. Defaults to 20.From 1 to 1000.

Outputs

countnumber
How many pings were returned
pingslist
The pings, newest first
uuidtext
The check
Example output
{
  "count": 1,
  "pings": [
    {
      "at": "2026-10-27T03:00:12.113073+00:00",
      "duration_seconds": 12.004,
      "from_address": "192.0.2.10",
      "method": "GET",
      "number": 42,
      "type": "success",
      "user_agent": "curl/8.5.0"
    }
  ],
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

List status changes

List when a check went down and came back up, newest first. Healthchecks keeps about three months.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.
Sincesincedate and time
Only changes after this moment.

Outputs

changeslist
The changes, newest first
countnumber
How many changes
uuidtext
The check
Example output
{
  "changes": [
    {
      "at": "2026-10-26T03:10:00+00:00",
      "status": "up"
    }
  ],
  "count": 1,
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Pause check

Pause a check, such as during maintenance, so it sends no alerts until it is pinged again.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.

Outputs

badge_urltext
Its status badge
descriptiontext
Its description
grace_minutesnumber
How late a ping may be before it goes down
integrationslist
The integrations it alerts
last_pingtext
When it last got a ping (ISO 8601); empty if never
nametext
Its name
next_pingtext
When the next ping is due (ISO 8601); empty if not known
period_minutesnumber
How often a ping is expected; empty for a scheduled check
ping_urltext
The address the job pings
pingsnumber
How many pings it has had
scheduletext
Its cron or OnCalendar schedule; empty for a period check
slugtext
Its slug
startedtrue/false
True while a job that sent a start signal runs
statustext
new, up, grace (late), down or paused
tagslist
Its tags
time_zonetext
The schedule's time zone
uuidtext
The check's UUID
Example output
{
  "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
  "description": "Runs ~/backup.sh",
  "grace_minutes": 60,
  "integrations": [
    "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
  ],
  "last_ping": "2026-10-27T03:00:12+00:00",
  "name": "Nightly backup",
  "next_ping": "2026-10-28T03:00:12+00:00",
  "period_minutes": null,
  "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
  "pings": 42,
  "schedule": "0 3 * * *",
  "slug": "nightly-backup",
  "started": false,
  "status": "paused",
  "tags": [
    "backup",
    "prod"
  ],
  "time_zone": "Europe/London",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Ping check

Tell Healthchecks.io a job succeeded, started or failed, or just log a message on the check, the way a cron job would.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.
Signalsignaltext
What happened. Defaults to success.One of: success, start (Started), fail (Failure), log (Log only (no status change)). Default: success.
Messagemessagetext
Text to keep with the ping, such as a summary of the job's output.

Outputs

acceptedtrue/false
True when Healthchecks answered OK
answertext
Healthchecks's answer, such as OK
signaltext
success, start, fail or log
uuidtext
The check pinged
Example output
{
  "accepted": true,
  "answer": "OK",
  "signal": "success",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

Resume check

Resume a paused check, so it alerts again when a ping is late.

Inputs

CheckchecktextRequired
The check. Pick one, or give its UUID or ping address.

Outputs

badge_urltext
Its status badge
descriptiontext
Its description
grace_minutesnumber
How late a ping may be before it goes down
integrationslist
The integrations it alerts
last_pingtext
When it last got a ping (ISO 8601); empty if never
nametext
Its name
next_pingtext
When the next ping is due (ISO 8601); empty if not known
period_minutesnumber
How often a ping is expected; empty for a scheduled check
ping_urltext
The address the job pings
pingsnumber
How many pings it has had
scheduletext
Its cron or OnCalendar schedule; empty for a period check
slugtext
Its slug
startedtrue/false
True while a job that sent a start signal runs
statustext
new, up, grace (late), down or paused
tagslist
Its tags
time_zonetext
The schedule's time zone
uuidtext
The check's UUID
Example output
{
  "badge_url": "https://healthchecks.io/b/2/1b9d0386-d07e-44b0-8995-4a9a372de43c.svg",
  "description": "Runs ~/backup.sh",
  "grace_minutes": 60,
  "integrations": [
    "1bdea468-03bf-47b8-ab27-29a9dd0e4b94"
  ],
  "last_ping": "2026-10-27T03:00:12+00:00",
  "name": "Nightly backup",
  "next_ping": "2026-10-28T03:00:12+00:00",
  "period_minutes": null,
  "ping_url": "https://hc-ping.com/31365bce-8da9-4729-8ff3-aaa71d56b712",
  "pings": 42,
  "schedule": "0 3 * * *",
  "slug": "nightly-backup",
  "started": false,
  "status": "new",
  "tags": [
    "backup",
    "prod"
  ],
  "time_zone": "Europe/London",
  "uuid": "31365bce-8da9-4729-8ff3-aaa71d56b712"
}

On this page