ntfy for Home Assistant (built-in integration)

About

ntfy is a built-in integration that connects Home Assistant to a ntfy notification service. It adds notifier and event entities, sensors for account usage and limits such as attachment storage, phone calls and emails, and an update entity for the ntfy version. Actions can publish a message to a topic, dismiss a sent message by marking it as read, or delete a message. The service address can be changed to use a different server, and SSL certificate verification can be turned off for self-signed certificates. Authentication works with a username and password or with an access token, and it is set up in the UI. Connection settings can be changed later without removing the integration.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Uses the vendor's cloud Needs an internet connection and an account with the vendor.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Change settings later Its connection settings can change without removing it.
Platinum quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Sensors

Setting it up

It is added under Settings, Devices and services, with Add integration.

Connect

Service URLAddress of the ntfy service. Modify this if you want to use a different server
Verify SSL certificateEnable SSL certificate verification for secure connections. Disable only if connecting to a ntfy instance using a self-signed certificate
PasswordEnter the password corresponding to the provided username for authentication
UsernameEnter the username required to authenticate with protected ntfy topics

Sign in again

PasswordEnter the password corresponding to the aforementioned username to automatically create an access token
Access tokenEnter a new access token. To create a new access token navigate to Account → Access tokens and select 'Create access token'

Change the connection

PasswordEnter the password corresponding to the provided username for authentication
Access tokenEnter a new or existing access token. To create a new access token navigate to Account → Access tokens and select 'Create access token'
UsernameEnter the username required to authenticate with protected ntfy topics

Change the connection

PasswordEnter the password corresponding to the aforementioned username to automatically create an access token
Access tokenEnter a new or existing access token. To create a new access token navigate to Account → Access tokens and select 'Create access token'

Texts from Home Assistant's source code, Apache License 2.0.

Entities

SensorsAttachment bandwidth limit, Attachment expiry duration, Attachment file size limit, Attachment storage, Attachment storage limit, Attachment storage remaining, Phone calls made, Phone calls usage limit, Phone calls remaining, Emails sent, Email usage limit, Emails remaining, and 8 more
Updatesntfy version

Actions

Dismiss notificationDismisses a previously sent message from a ntfy topic by marking it as read.Fields: Sequence ID
Delete notificationDeletes a message from a ntfy topic.Fields: Sequence ID
Publish notificationPublishes a notification message to a ntfy topic.Fields: Action buttons, Attachment URL, Attach local file, Phone call, Click URL, Delay delivery, Forward to email, Attachment filename, Icon URL, Format as Markdown