https://github.com/ndom91/homeassistant-checkly

Home Assistant Integration for Checkly
https://github.com/ndom91/homeassistant-checkly

checkly homeassistant homeassistant-integration

Last synced: 2 months ago
JSON representation

Home Assistant Integration for Checkly

• Host: GitHub
• URL: https://github.com/ndom91/homeassistant-checkly
• Owner: ndom91
• License: mit
• Created: 2022-08-07T15:08:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-18T23:34:44.000Z (about 2 years ago)
• Last Synced: 2024-10-04T19:20:01.465Z (3 months ago)
• Topics: checkly, homeassistant, homeassistant-integration
• Language: Python
• Homepage: https://checklyhq.com
• Size: 118 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Checkly

[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=ndom91&repository=homeassistant-checkly&category=integration)

[Home Assistant](https://www.home-assistant.io/) integration to add sensors for your Checkly API and Browser checks!

![Screenshot](screenshot.png)

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

```bash

$ cd /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](https://app.checklyhq.com/settings/account/general) 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](https://github.com/home-assistant/core/tree/dev/homeassistant/components/uptimerobot) Integration ❤️

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

## 📝 License

MIT