https://github.com/custom-components/healthchecksio

Update and display the status of your healthchecks.io checks.
https://github.com/custom-components/healthchecksio

api-client healthchecksio monitor

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/custom-components/healthchecksio
• Owner: custom-components
• License: mit
• Created: 2019-08-12T16:02:36.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T18:52:42.000Z (about 1 year ago)
• Last Synced: 2024-05-01T14:33:34.401Z (6 months ago)
• Topics: api-client, healthchecksio, monitor
• Language: Python
• Size: 193 KB
• Stars: 46
• Watchers: 4
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# healthchecksio

[![GitHub Release][releases-shield]][releases]

[![GitHub Activity][commits-shield]][commits]

[![License][license-shield]](LICENSE.md)

[![hacs][hacsbadge]](hacs)

![Project Maintenance][maintenance-shield]

[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][forum]

_Integration to integrate with [healthchecks.io][healthchecksio]._

![example][exampleimg]

## Installation

Search for and install `healthchecksio` from [HACS](https://hacs.xyz/)

## Configuration

This integration can **only** be configured via the UI.

### Check ID

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

This integration will send an update to it every `5` minutes.

### API Key

The API key to your account.

You can find it under the "Settings" tab in your project.

## 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](CONTRIBUTING.md)

***

[healthchecksio]: https://healthchecks.io

[buymecoffee]: https://www.buymeacoffee.com/ludeeus

[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge

[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/healthchecksio.svg?style=for-the-badge

[commits]: https://github.com/custom-components/healthchecksio/commits/master

[hacs]: https://github.com/custom-components/hacs

[hacsbadge]: https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge

[discord]: https://discord.gg/Qa5fW2R

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge

[exampleimg]: example.png

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge

[forum]: https://community.home-assistant.io/

[license-shield]: https://img.shields.io/github/license/custom-components/healthchecksio.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/maintainer-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge

[releases-shield]: https://img.shields.io/github/release/custom-components/healthchecksio.svg?style=for-the-badge

[releases]: https://github.com/custom-components/healthchecksio/releases