mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-30 23:06:49 +00:00
b39bd81c6e
* Spelling fixes * "It's" -> "its" fixes * Fix capitalization of "Pi" in "Raspberry Pi" "Pi", not "PI" or "pi".
105 lines
3.1 KiB
Markdown
105 lines
3.1 KiB
Markdown
---
|
|
layout: page
|
|
title: "Pushsafer"
|
|
description: "Instructions how to add Pushsafer notifications to Home Assistant."
|
|
date: 2018-01-05 11:15
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: pushsafer.png
|
|
ha_category: Notifications
|
|
ha_release: 0.39
|
|
---
|
|
|
|
|
|
The [Pushsafer service](https://www.pushsafer.com/) is a platform for the notify component. This allows you to send messages to the user using Pushsafer.
|
|
|
|
In order to get a private or alias key you need to go to the [Pushsafer website](https://www.pushsafer.com) and register.
|
|
|
|
To use Pushsafer notifications, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: pushsafer
|
|
private_key: ABCDEFGHJKLMNOPQRSTUVXYZ
|
|
```
|
|
|
|
**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`.
|
|
- **private_key** (*Required*): Your private or alias key. Private key = send the notification to all devices with standard params, alias key send the notification to the devices stored in the alias with predefined params.
|
|
|
|
### {% linkable_title Examples %}
|
|
|
|
Message to two devices with formatted text.
|
|
|
|
```json
|
|
{
|
|
"title": "Test to 2 devices",
|
|
"message": "Attention [b]bold[/b] text[br][url=https://www.pushsafer.com]Link to Pushsafer[/url]",
|
|
"target": ["1111", "2222"],
|
|
"data": {
|
|
"icon": "2",
|
|
"iconcolor": "#FF0000",
|
|
"sound": "2",
|
|
"vibration": "1",
|
|
"url": "https://home-assistant.io/",
|
|
"urltitle": "Open Home Assistant",
|
|
"time2live": "0"
|
|
}
|
|
}
|
|
```
|
|
|
|
Message to one device with formatted text and image from an external URL.
|
|
|
|
```json
|
|
{
|
|
"title": "Test to 1 device with image from an url",
|
|
"message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]",
|
|
"target": ["1111"],
|
|
"data": {
|
|
"icon": "14",
|
|
"iconcolor": "#FFFF00",
|
|
"sound": "22",
|
|
"vibration": "3",
|
|
"url": "https://home-assistant.io/",
|
|
"urltitle": "Open Home Assistant",
|
|
"time2live": "60",
|
|
"picture1": {
|
|
"url":"https://home-assistant.io/images/components/alexa/alexa-512x512.png"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Message to two devices and one device group with formatted text and local image.
|
|
|
|
```json
|
|
{
|
|
"title": "Test to 3 devices with local image",
|
|
"message": "Attention [i]italic[/i] Text[br][url=https://home-assistant.io/]Testlink[/url]",
|
|
"target": ["1111","2222","gs3333"],
|
|
"data": {
|
|
"icon": "20",
|
|
"iconcolor": "#FF00FF",
|
|
"sound": "33",
|
|
"vibration": "0",
|
|
"url": "https://home-assistant.io/",
|
|
"urltitle": "Open Home Assistant",
|
|
"time2live": "10",
|
|
"picture1": {
|
|
"path":"C:\\Users\\Kevin\\AppData\\Roaming\\.homeassistant\\image-760-testimage.jpg"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
To customize your push-notification you can take a look at the [Pushsafer API description](https://www.pushsafer.com/en/pushapi).
|
|
|
|
When setting up the application you can use this [icon](https://home-assistant.io/images/favicon-192x192.png).
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|