jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add attachment documentation for Simplepush (#26813)

Browse Source
This commit is contained in:
Timm Schäuble 2023-04-03 19:59:51 +02:00 committed by GitHub
parent 98afb95d45
commit 092a395511
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
source/_integrations/simplepush.markdown
View File

@ -14,17 +14,55 @@ ha_codeowners:
- '@engrbm87'
---
The `simplepush` platform uses [Simplepush](https://simplepush.io/) to deliver notifications from Home Assistant to your Android device. Unlike similar apps the Simplepush app requires no registration.
The `simplepush` platform uses [Simplepush](https://simplepush.io/) to deliver notifications from Home Assistant to your Android and iOS device. Unlike similar apps the Simplepush app requires no registration and supports end-to-end encryption.
{% include integrations/config_flow.md %}
To test if the service works, just send a message with `curl` from the command-line.
```bash
curl 'https://api.simplepush.io/send/device_key/title/message'
curl 'https://simplepu.sh/YOUR_SIMPLEPUSH_KEY/message'
```
If you enter your password and salt (as defined in the Simplepush app settings) during the configuration of this integration, all notifications sent from this integration will be end-to-end encrypted.
## Notifications
Simplepush can send a notification by calling the [`notify` service](/integrations/notify/). You can specify the `event` under the `data` key. This will override the event configured in YAML when imported.
Simplepush can send a notification by calling the [`notify` service](/integrations/notify/).
You can specify the `event` under the `data` key.
Events can be used to customize the notification behavior.
It is also possible to specify `attachments` under the `data` key.
Attachments can be images, GIFs or video files that are accessible by a URL.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
## Examples
Send a notification with a title and event.
```yml
- service: notify.simplepush
data:
title: "This is the title"
message: "This is the message"
data:
event: "event"
```
Send a notification with four attachments defined by their URL.
Attachments can be images, GIFs or video files.
```yml
- service: notify.simplepush
data:
message: "This is the message"
data:
attachments:
- image: "https://upload.wikimedia.org/wikipedia/commons/e/ee/Sample_abc.jpg"
- image: "https://upload.wikimedia.org/wikipedia/commons/d/d3/Newtons_cradle_animation_book_2.gif"
- video: "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"
- video: "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/ElephantsDream.mp4"
thumbnail: "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/images/ForBiggerEscapes.jpg"
```