ntfy

The ntfy integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows publishing push notifications on ntfy.sh or other ntfy services.

About ntfy

ntfy is a simple HTTP-based pub-sub notification service that allows you to send notifications to phones or desktops. The official ntfy service also provides additional features, such as notifications via email or phone calls using text-to-speech to read messages aloud. Since ntfy is 100% open-source, you can choose to use alternative public ntfy services or even host your own instance.

How you can use this integration

The ntfy integration can be used to send push notifications from automations and scripts in real-time to your mobile devices and desktops.

Prerequisites

1. Service URL

   To set up the ntfy integration, you need the URL of the ntfy service you wish to use.

   • Use https://ntfy.sh for the official ntfy service.
   • Provide the URL of an alternative public ntfy service or your self-hosted instance (for example, https://your-ntfy-instance.com).

2. Authentication (optional)

   Depending on whether the server is configured to support access control, some topics may be read/write protected so that only users with the correct credentials can subscribe or publish to them.

   The ntfy integration uses access token authentication to access protected topics. When you provide your ntfy username and password, Home Assistant automatically generates and uses an access token for authentication.

3. Adding a topic

   To set up topics for notifications, select Add topic, then, if prompted, select the ntfy service you previously configured.

   You can now choose one of the following options:

   • Select Enter topic to add a new topic. Use an existing topic name by retrieving it from the ntfy app or the ntfy service’s website. Simply copy and paste the topic name into the configuration.
   • Select Generate topic name to allow the integration to generate a random topic name automatically.

   Repeat these steps for each topic you want to add.

Configuration

To add the ntfy integration to your Home Assistant instance, use this My button:

Configuration parameters

Service parameters

Topic parameters

Notifiers

The ntfy integration will add a deviceA device is a model representing a physical or logical unit that contains entities. with an associated notify entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] for each configured topic. To publish notifications, you can use the notify.send_message actionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called sequence. [Learn more]. To use notifications, please see the getting started with automation page.

action: notify.send_message
data:
  message: "Reminder: Have you considered frogs?"
  entity_id: notify.mytopic

Events

An eventEvery time something happens in Home Assistant, an event is fired. There are different types of events, such as state change events, when an action was triggered, or the time changed. All entities produce state change events. Every time a state changes, a state change event is produced. Events can be used to trigger automations or scripts. For example, you can trigger an automation when a light is turned on, then a speaker turns on in that room. Events can also be used to trigger actions in the frontend. For example, you can trigger an action when a button is pressed. [Learn more] entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] is created for each configured topic. These entities subscribe to their respective topics and receive notifications from the ntfy service in real-time. Each event entity exposes the full contents of the notification through its attributes. These attributes include links, attachments, tags, and other metadata.

You can use eventEvery time something happens in Home Assistant, an event is fired. There are different types of events, such as state change events, when an action was triggered, or the time changed. All entities produce state change events. Every time a state changes, a state change event is produced. Events can be used to trigger automations or scripts. For example, you can trigger an automation when a light is turned on, then a speaker turns on in that room. Events can also be used to trigger actions in the frontend. For example, you can trigger an action when a button is pressed. [Learn more] entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] in automations. For example, to trigger actions in Home Assistant, or to forward notifications to other devices for further processing or alerting.

triggers:
  - trigger: numeric_state
    entity_id:
      - event.mytopic
    attribute: priority
    above: 4
actions:
  - action: notify.mobile_app_your_device
    data:
      message: "Received new ntfy notification"

Actions

Publish notification

For more customizable notifications, use the ntfy.publish action instead of notify.send_message. With ntfy.publish, you can take full advantage of the ntfy service’s capabilities. These include setting a priority, adding links, attachments, tags, and emojis.

Parameters

• title: Title for your notification message.
• message: Your notification message.
• markdown: Enable Markdown formatting for the message body. See the Markdown guide for syntax details: https://www.markdownguide.org/basic-syntax/.
• tags: Add tags or emojis to the notification. Emojis (using shortcodes like smile) will appear in the notification title or message. Other tags will be displayed below the notification content.
• priority: All messages have a priority, which defines how urgently your phone notifies you, depending on the configured vibration patterns, notification sounds, and visibility in the notification drawer or pop-over.
• click: URL that is opened when the notification is clicked.
• delay: Set a delay for message delivery. The minimum delay is 10 seconds, and the maximum delay is 3 days.
• attach: Attach images or other files by URL.
• email: Specify the address to forward the notification to, for example mail@example.com.
• call: Phone number to call and read the message out loud using text-to-speech. Requires ntfy Pro and prior phone number verification.
• icon: Include an icon that will appear next to the text of the notification. Only JPEG and PNG images are supported.

action: ntfy.publish
data:
  title: "Server Alert"
  message: "CPU usage exceeded 90%."
  priority: "5"
  click: "https://homeassistant.local"
  tags:
    - rotating_light
target:
  entity_id: notify.mytopic

Sensors

The ntfy integration adds a device representing the service, along with various sensors that display your usage statistics and current account limits.

📊 Message stats

• Messages published: The total number of messages sent today.
• Messages remaining: The number of messages that can still be sent before the daily limit is reached.
• Messages usage limit: The maximum number of messages allowed per day on the account.
• Messages expiry duration: The duration for which published messages are cached before automatic deletion.

✉️ Email stats

• Emails sent: The number of email notifications sent today.
• Emails remaining: The number of email notifications that can still be sent today.
• Email usage limit: The daily limit for email notifications on the account.

📞 Phone call stats

• Phone calls made: The total phone call alerts made today.
• Phone calls remaining: The number of phone call alerts that can still be made today.
• Phone calls usage limit: The maximum number of phone call alerts allowed per day on the account.

🔒 Reserved topics

• Reserved topics: The number of reserved topics currently assigned to the account.
• Reserved topics remaining: The number of topics that can still be reserved.
• Reserved topics limit: The maximum number of reserved topics allowed for the account.

📎 Attachment stats

• Attachment storage: The amount of storage space currently used by file attachments.
• Attachment storage remaining: The remaining storage capacity available for attachments.
• Attachment storage limit: The total storage quota allocated for attachments.
• Attachment expiry duration: The duration attachments are retained before being automatically deleted.
• Attachment file size limit: The maximum allowed size for a single attachment file.
• Attachment bandwidth limit: The daily bandwidth cap for uploading and downloading attachments.

⭐ Account

• Subscription tier: The subscription plan currently assigned to the ntfy account.

Data updates

The integration retrieves data from ntfy.sh (or your own ntfy instance) every 15 minutes to update the usage statistics sensors.

Known limitations

ntfy imposes various rate and usage limits. The official ntfy.sh service allows up to 60 messages in a burst, with a replenishment rate of one message every 5 seconds (i.e., the full 60-message capacity refills in 5 minutes).

Additional usage limits depend on your account tier. To view your current limits, go to Account → Usage.

Limits may vary when using other ntfy services. If you’re using a self-hosted instance, you can configure higher limits or disable them entirely.

Troubleshooting

The ntfy integration relies on an active internet connection to communicate with the ntfy service. If you encounter issues, verify that your network connection is stable and the ntfy service is reachable. Additionally, the ntfy service itself may experience downtime, whether unexpected or due to scheduled maintenance.

In any case, when reporting an issue, please enable debug logging, restart the integration, and as soon as the issue reoccurs, stop the debug logging again (download of debug log file will start automatically). Further, if still possible, please also download the diagnostics data. If you have collected the debug log and the diagnostics data, provide them with the issue report.

Removing the integration

This integration can be removed by following these steps:

To remove an integration instance from Home Assistant

1. Go to Settings > Devices & services and select the integration card.
2. From the list of devices, select the integration instance you want to remove.
3. Next to the entry, select the three dots menu. Then, select Delete.