Skip to content

Update and display the status of your healthchecks.io checks.

License

Notifications You must be signed in to change notification settings

custom-components/healthchecksio

Repository files navigation

healthchecksio

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Integration to integrate with healthchecks.io.

example

Installation

Search for and install healthchecksio from HACS

Configuration

This integration can only be configured via the UI.

Check ID

This is the ID of the check that the integration should update. It looks something like aa247c51-8da8-4800-86a3-48763142e902.

What the integration does

  • Pings the specified Healthchecks.io check every 5 minutes to monitor the state of Home Assistant.
  • Pulls your other Healthchecks.io checks as entities, so you can monitor their statuses directly in Home Assistant.

API Key

The API key to your account. You can find it under the "Settings" tab in your project.

Note

A Full Access API key is required for this integration to function correctly. This is because the integration both pings checks (which requires write access) and reads the status of all your checks to create entities in Home Assistant (which requires read access). Only the Full Access key provides both permissions needed for these operations.

For self-hosted instances

Site Root

This is the root URL of your Healthchecks.io instance.

Ping Endpoint

This is the path of the endpoint used for pings.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Analytics

If you are using this integration, please consider enabling Home Assistant usage analytics.