Prowl

The Prowl integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] uses Prowl to deliver push notifications from Home Assistant to your iOS device.

Prerequisites

Go to the Prowl website and create a new API key.

Configuration

To add the Prowl service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

API key

The Prowl API key you created on the Prowl website.

Sending notifications

The Prowl integration adds a 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 API key. To send a notification, use the Send a notification message (notify.send_message) actionAn action makes Home Assistant do something, for example, turn on a light, send a notification, or activate a scene. Automations and scripts run a list of actions. [Learn more] and select the Prowl notify entity as the target. To set a priority or attach a URL, use the Prowl: Send message (prowl.send_message) action instead.

ActionAn action makes Home Assistant do something, for example, turn on a light, send a notification, or activate a scene. Automations and scripts run a list of actions. [Learn more]
action: notify.send_message
target:
  entity_id: notify.prowl
data:
  title: "Reminder"
  message: "Have you considered frogs?"

List of actions

The Prowl integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.

  • Send message (prowl.send_message) Send a Prowl push notification. Optionally set a priority and a URL that opens when the notification is selected.

For an overview of every action across all integrations, see the actions reference.

Prowl automation examples

You can use this integration to send a push notification to your iOS device when something happens in your home.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the visual automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Automation: send a notification when the front door opens

This automation sends a high-priority notification when the front door opens.

  • Trigger: Door opened
    • Target: Front door (binary_sensor.front_door)
  • Action: Send message
    • Target: Prowl (notify.prowl)
    • Priority: High
YAML example for a notification when the front door opens
AutomationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more]
alias: "Prowl: front door opened"
triggers:
  - trigger: door.opened
    target:
      entity_id: binary_sensor.front_door
actions:
  - action: prowl.send_message
    target:
      entity_id: notify.prowl
    data:
      title: "Front door"
      message: "The front door was opened."
      priority: high

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. Next to the entry you want to remove, select the three dots menu. Then, select Delete.
    • Depending on the integration, the entries are listed under one of the following headings:
      • Devices
      • Hubs
      • Services
      • Integration entries
  3. To confirm, select Delete.
    • Home Assistant also deletes the devices and entities of the entry.
  4. If Home Assistant asks you to restart, restart Home Assistant.
  5. If Home Assistant asks whether to also delete the application credentials, select Remove or Keep.