# Healthchecks.io

> 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.

App · 11 actions. Web page: https://docs.lodol.com/docs/integrations/healthchecks

## Actions

### Change check

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

**Inputs**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.
- Name (`name`, text): A new name. Leave empty to keep it.
- Tags (`tags`, list): Its tags, replacing the ones it has. Leave empty to keep them.
- Description (`description`, text): What the check is for. Leave empty to keep it.
- Expect a ping every (minutes) (`period_minutes`, number): How often the job runs, such as 60 for hourly. Leave empty to keep it. From 1 to 525600.
- Or on a schedule (`schedule`, text): Instead of a period, a cron expression such as 0 3 * * * (3am daily).
- Schedule time zone (`time_zone`, text): The time zone the schedule is in, such as Europe/London. Defaults to UTC.
- Grace time (minutes) (`grace_minutes`, number): How late a ping may be before the check goes down. Leave empty to keep it. From 1 to 525600.
- Alert through (`integrations`, list): The integrations to alert when it goes down. Leave empty to keep it.

**Outputs**

- `badge_url` (text): Its status badge
- `description` (text): Its description
- `grace_minutes` (number): How late a ping may be before it goes down
- `integrations` (list): The integrations it alerts
- `last_ping` (text): When it last got a ping (ISO 8601); empty if never
- `name` (text): Its name
- `next_ping` (text): When the next ping is due (ISO 8601); empty if not known
- `period_minutes` (number): How often a ping is expected; empty for a scheduled check
- `ping_url` (text): The address the job pings
- `pings` (number): How many pings it has had
- `schedule` (text): Its cron or OnCalendar schedule; empty for a period check
- `slug` (text): Its slug
- `started` (true/false): True while a job that sent a start signal runs
- `status` (text): new, up, grace (late), down or paused
- `tags` (list): Its tags
- `time_zone` (text): The schedule's time zone
- `uuid` (text): The check's UUID

**Example output**

```json
{
  "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**

- Name (`name`, text, required): What the check watches, such as Nightly backup.
- Slug (`slug`, text): A short name for pinging by slug: a-z, 0-9, '-' and '_'.
- Tags (`tags`, list): Tags to group it by.
- Description (`description`, text): What the check is for.
- Expect a ping every (minutes) (`period_minutes`, number): How often the job runs, such as 60 for hourly. Defaults to a day. From 1 to 525600.
- Or on a schedule (`schedule`, text): Instead of a period, a cron expression such as 0 3 * * * (3am daily).
- Schedule time zone (`time_zone`, text): The time zone the schedule is in, such as Europe/London. Defaults to UTC.
- Grace time (minutes) (`grace_minutes`, number): How late a ping may be before the check goes down. Defaults to an hour. From 1 to 525600.
- Alert through (`integrations`, list): The integrations to alert when it goes down.
- Update if it exists (`update_if_exists`, true/false): Change the check with this name instead of making a second one. Off by default. Default: `false`.

**Outputs**

- `badge_url` (text): Its status badge
- `description` (text): Its description
- `grace_minutes` (number): How late a ping may be before it goes down
- `integrations` (list): The integrations it alerts
- `last_ping` (text): When it last got a ping (ISO 8601); empty if never
- `name` (text): Its name
- `next_ping` (text): When the next ping is due (ISO 8601); empty if not known
- `period_minutes` (number): How often a ping is expected; empty for a scheduled check
- `ping_url` (text): The address the job pings
- `pings` (number): How many pings it has had
- `schedule` (text): Its cron or OnCalendar schedule; empty for a period check
- `slug` (text): Its slug
- `started` (true/false): True while a job that sent a start signal runs
- `status` (text): new, up, grace (late), down or paused
- `tags` (list): Its tags
- `time_zone` (text): The schedule's time zone
- `uuid` (text): The check's UUID

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.

**Outputs**

- `deleted` (true/false): True once deleted
- `name` (text): Its name
- `uuid` (text): The deleted check's UUID

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.

**Outputs**

- `badge_url` (text): Its status badge
- `description` (text): Its description
- `grace_minutes` (number): How late a ping may be before it goes down
- `integrations` (list): The integrations it alerts
- `last_ping` (text): When it last got a ping (ISO 8601); empty if never
- `name` (text): Its name
- `next_ping` (text): When the next ping is due (ISO 8601); empty if not known
- `period_minutes` (number): How often a ping is expected; empty for a scheduled check
- `ping_url` (text): The address the job pings
- `pings` (number): How many pings it has had
- `schedule` (text): Its cron or OnCalendar schedule; empty for a period check
- `slug` (text): Its slug
- `started` (true/false): True while a job that sent a start signal runs
- `status` (text): new, up, grace (late), down or paused
- `tags` (list): Its tags
- `time_zone` (text): The schedule's time zone
- `uuid` (text): The check's UUID

**Example output**

```json
{
  "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**

- Tags (`tags`, list): Only checks with all of these tags.
- Status (`status`, text): 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`.
- Slug (`slug`, text): Only the check with this slug.

**Outputs**

- `checks` (list): The checks
- `count` (number): How many checks
- `down_count` (number): How many are down

**Example output**

```json
{
  "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**

- `count` (number): How many integrations
- `integrations` (list): The integrations

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.
- How many (`limit`, number): How many pings, newest first. Defaults to 20. From 1 to 1000.

**Outputs**

- `count` (number): How many pings were returned
- `pings` (list): The pings, newest first
- `uuid` (text): The check

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.
- Since (`since`, date and time): Only changes after this moment.

**Outputs**

- `changes` (list): The changes, newest first
- `count` (number): How many changes
- `uuid` (text): The check

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.

**Outputs**

- `badge_url` (text): Its status badge
- `description` (text): Its description
- `grace_minutes` (number): How late a ping may be before it goes down
- `integrations` (list): The integrations it alerts
- `last_ping` (text): When it last got a ping (ISO 8601); empty if never
- `name` (text): Its name
- `next_ping` (text): When the next ping is due (ISO 8601); empty if not known
- `period_minutes` (number): How often a ping is expected; empty for a scheduled check
- `ping_url` (text): The address the job pings
- `pings` (number): How many pings it has had
- `schedule` (text): Its cron or OnCalendar schedule; empty for a period check
- `slug` (text): Its slug
- `started` (true/false): True while a job that sent a start signal runs
- `status` (text): new, up, grace (late), down or paused
- `tags` (list): Its tags
- `time_zone` (text): The schedule's time zone
- `uuid` (text): The check's UUID

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.
- Signal (`signal`, text): What happened. Defaults to success. One of: `success`, `start` (Started), `fail` (Failure), `log` (Log only (no status change)). Default: `success`.
- Message (`message`, text): Text to keep with the ping, such as a summary of the job's output.

**Outputs**

- `accepted` (true/false): True when Healthchecks answered OK
- `answer` (text): Healthchecks's answer, such as OK
- `signal` (text): success, start, fail or log
- `uuid` (text): The check pinged

**Example output**

```json
{
  "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**

- Check (`check`, text, required): The check. Pick one, or give its UUID or ping address.

**Outputs**

- `badge_url` (text): Its status badge
- `description` (text): Its description
- `grace_minutes` (number): How late a ping may be before it goes down
- `integrations` (list): The integrations it alerts
- `last_ping` (text): When it last got a ping (ISO 8601); empty if never
- `name` (text): Its name
- `next_ping` (text): When the next ping is due (ISO 8601); empty if not known
- `period_minutes` (number): How often a ping is expected; empty for a scheduled check
- `ping_url` (text): The address the job pings
- `pings` (number): How many pings it has had
- `schedule` (text): Its cron or OnCalendar schedule; empty for a period check
- `slug` (text): Its slug
- `started` (true/false): True while a job that sent a start signal runs
- `status` (text): new, up, grace (late), down or paused
- `tags` (list): Its tags
- `time_zone` (text): The schedule's time zone
- `uuid` (text): The check's UUID

**Example output**

```json
{
  "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"
}
```
