Checkly

Home Assistant integration to add sensors for your Checkly API and Browser checks!

🚧 Installation

1. The integration can be found in HACS by searching for 'Checkly'.

2. Select it and chose "Download".

🏗 Manual Installation

1. Clone the repository into your /custom_components directory.

$ cd <config_dir>/custom_components
$ git clone https://github.com/ndom91/homeassistant-checkly.git checkly

2. Once you've cloned this into the custom_components directory, restart HomeAssistant.

⚙ Configuration

To add your Checks to Home Assistant, you have to add the custom integration as follows.

1. In Home Assistant, go to Settings -> Devices & Services
2. Under the Integrations tab, click Add Integration and search for Checkly in the list of available options.
3. When selected, a pop-up will open asking you for your Checkly API Token and Account ID. These can both be found in the Settings area of the Checkly Webapp.
4. Once confirmed, you will be shown a list of all of your Checks at which point you can assign them to "Areas", if you wish.

Now you should have sensors for the passing/failing state for each of your checks available in your Home Assistant. You can now create automations based off of these, or just display them on your dashboard.

This will poll Checkly every 90s for updates. If you want this to be user adjustable, please open an issue.

👷 Contributing

Initially based off of the UptimeRobot Integration ❤️

We are happy to accept most contributions. Please open a PR!

📝 License

MIT