The ntfy.sh notification platform enables you to easily send notifications with a custom prioirty and extra information via ntfy.sh.
The recommended way to install the integration is via HACS. Add this repository to HACS custom integration repositories and install.
If you want to install it manually download the repository as zip and extract it to the <config_dir>/custom_components/ directory of HomeAssistant.
This integration exposes itself as a notifications integration and configured by adding the folowing snippet to the configuration.yaml file:
notify:
- name: "my ntfy"
platform: ntfy
url: <ntfy.sh_url>
token: <ntfy.sh_token>
topic: <ntfy.sh_topic>
icon: <notification_icon_url>Replace <ntfy.sh_url>, <ntfy.sh_token>, <ntfy.sh_topic>, and <notification_icon_url> with the url, optional token, optional topic, and optional icon url for your ntfy.sh instance. Token is optional if your instance does not require authentication. Topic is also optional and will default to homeassistant if not specified. Topics in the automations have higher priority.
This integration accepts the same values as the official ntfy.sh API. For a full list of options that can be added to a notification refer to the ntfy.sh docs. Here a few examples:
action:
- service: notify.my_ntfy
data:
message: "This is a test message."action:
- service: notify.my_ntfy
data:
message: "This is a test message."
title: "ntfy Test"
data:
priority: 10action:
- service: notify.my_ntfy
data:
message: "This is a test message."
title: "ntfy Test"
data:
priority: 10
click: https://www.home-assistant.io/action:
- service: notify.my_gotify
data:
message: "This is a test message."
title: "Gotify Test"
data:
priority: 10
image: https://placekitten.com/400/300action:
- service: notify.my_gotify
data:
message: "This is a test message."
title: "Gotify Test"
topic: "override_default_topic"
data:
tags: [tags]
priority: 3
attach: https://placekitten.com/400/300
filename: filename.jpg
click: https://www.home-assistant.io/
actions: [list_of_actions]
icon: https://placekitten.com/400/300The whole project is under the GPL-3 license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent