mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 08:16:53 +00:00
Update notify docs
This commit is contained in:
parent
81b4d8701c
commit
804aa8d9bc
@ -9,22 +9,39 @@ sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
One of the things most people want at some point in their home automation is to get notified when certain events occur. For this reason there is a `notify` component in Home Assistant.
|
||||
The `notify` component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported.
|
||||
|
||||
Home Assistant currently supports a wide range of services for notifications. Please check the sidebar for a full list of platforms.
|
||||
### Configuration
|
||||
|
||||
If your are running into troubles with your notification platform, a simple way to test it is to use **Call Service** from the **Developer Tools**. Choose your service (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
|
||||
|
||||
```json
|
||||
{"message":"A simple test message from HA."}
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
platform: pushbullet
|
||||
# Optional name for the notify service
|
||||
name: paulus
|
||||
# api_key is a required config key by the pushbullet platform
|
||||
api_key: ABCDEFG
|
||||
```
|
||||
|
||||
This will send a single message to your notification platform configured in your `configuration.yaml` file.
|
||||
The **name** parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service `notify/<name>`. The name will default to `notify` if not supplied.
|
||||
|
||||
### Service
|
||||
|
||||
Once loaded, the `notify` platform will expose a service that can be called to send notifications.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `title` | yes | Can be used to set a title for the message. The default is `Home Assistant`.
|
||||
| `message` | no | Message to send to recipient.
|
||||
| `message` | no | Body of the notification.
|
||||
| `title` | yes | Title of the notification. Default is `Home Assistant`.
|
||||
| `target` | yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported.
|
||||
|
||||
|
||||
For more automation examples, see the [getting started with automation page](/getting-started/automation/) or the [configuration cookbook](/cookbook).
|
||||
### Test if it works
|
||||
|
||||
A simple way to test if you have set up your notify platform correctly is to use **Call Service** from the **Developer Tools** to call your notify service. Choose your service (*notify/xyz*) from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "A simple test message from HA."
|
||||
}
|
||||
```
|
||||
|
@ -12,22 +12,44 @@ ha_category: Notifications
|
||||
featured: true
|
||||
---
|
||||
|
||||
[PushBullet](https://www.pushbullet.com/) is a free service to send information between your phones, browsers and friends.
|
||||
|
||||
Home Assistant currently supports the awesome [PushBullet](https://www.pushbullet.com/), a free service to send information between your phones, browsers and friends.
|
||||
|
||||
To add PushBullet to your installation, add the following to your `configuration.yaml` file:
|
||||
### Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
notify:
|
||||
name: NOTIFIER_NAME
|
||||
platform: pushbullet
|
||||
api_key: YOUR_API_KEY
|
||||
# Optional
|
||||
name: NOTIFIER_NAME
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **api_key** (*Required*): Enter the API key for PushBullet. Go to https://www.pushbullet.com/ to retrieve your API key.
|
||||
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
|
||||
For more automation examples, see the [getting started with automation page]({{site_root}}/components/automation/).
|
||||
### Usage
|
||||
|
||||
PushBullet is a notify platform and thus can be controlled by calling the notify service [as described here](/components/notify/). An optional **target** parameter can be given to PushBullet to specify one or many account's devices, contacts or channels to notify.
|
||||
|
||||
Type | Prefix | Suffix | Example
|
||||
---- | ------ | ------ | -------
|
||||
All devices | `device` | -- | `device`
|
||||
Device | `device/` | Device nickname | `device/iphone`
|
||||
Contact | `contact/` | Contact e-mail | `contact/email@example.com`
|
||||
Channel | `channel/` | Channel tag | `channel/my_home`
|
||||
|
||||
#### Example service payload
|
||||
|
||||
```json
|
||||
{
|
||||
"message": "A message for many people",
|
||||
"target": [
|
||||
"device",
|
||||
"contact/hello@example.com",
|
||||
"channel/my_home"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user