mirror of
https://github.com/caronc/apprise.git
synced 2024-12-04 22:11:25 +01:00
Created Notify_bark (markdown)
parent
09b8fddba6
commit
8f13d0fc0c
38
Notify_bark.md
Normal file
38
Notify_bark.md
Normal file
@ -0,0 +1,38 @@
|
||||
## Bark Notifications
|
||||
* **Source**: https://github.com/Finb/bark-server ([Bark itself identified here](https://github.com/Finb/Bark))
|
||||
* **Icon Support**: No
|
||||
* **Message Format**: Text
|
||||
* **Message Limit**: not set
|
||||
|
||||
Bark is an iOS App which allows you to push custom notifications to your iPhone.
|
||||
|
||||
### Syntax
|
||||
Valid authentication syntax is as follows:
|
||||
* `bark://{host}/{device_key}`
|
||||
* `bark://{host}:{port}/{device_key}`
|
||||
|
||||
You can also notify more the one device at a time.
|
||||
* `bark://{host}:{port}/{device_key1}/{device_key2}/{device_keyN}/`
|
||||
|
||||
### Parameter Breakdown
|
||||
| Variable | Required | Description
|
||||
| ----------- | -------- | -----------
|
||||
| device_key | Yes | The device key you wish to notify
|
||||
| sound | No | Optionally set a sound file to be played with notification sent. Supported sounds are identified [here](https://github.com/Finb/Bark/tree/master/Sounds)
|
||||
| click | No | Provide a hyperlink that should be associated with the notification
|
||||
| level | No | Specify the message level. Can be either **active**, **timeSensitive**, or **passive**.
|
||||
| badge | No | Provide a numerical value of 0 (zero) or greater to associate a badge with the bark icon on the iOS device.
|
||||
| category | No | Associate a category with your notification
|
||||
| group | No | Associate a group with your notification
|
||||
| image | No | Set to `no` if you do not want the Apprise alert level being placed as the icon associated with the message.
|
||||
|
||||
#### Example
|
||||
Send a Bark notification to all devices associated with a project:
|
||||
```bash
|
||||
# Assume:
|
||||
# - our {hostname} is localhost
|
||||
# - our {port} is 8080
|
||||
# - our {device_key} is j300012fl9y0b5AW9g9Nsejb8P
|
||||
apprise -vv -t "Test Message Title" -b "Test Message Body" \
|
||||
bark://localhost:8080/j300012fl9y0b5AW9g9Nsejb8P
|
||||
```
|
Loading…
Reference in New Issue
Block a user