extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-01-05 21:49:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_spontit (markdown)

Chris Caron 2020-07-27 22:11:04 -04:00
parent f18a085099
commit 6c9ea2ddf0
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Notify_spontit.md

@ -14,14 +14,12 @@ Channels are optional; if no channel is specified then you are just personally n
* `spontit://{user}@{apikey}/{channel_id}`
* `spontit://{user}@{apikey}/{channel_id1}/{channel_id2}/{channel_idN}/`
**Note**: When notifying a channel, by default the channel follows this structure ([according to their API](https://api.spontit.com/)): `user_id/channelname`. The slash (/) between the `{user_id}` and `{channelname}` unfortunately conflicts with the slash delimiter already used by Apprise. You must either encode the slash (replace it with **%2F** - [see here](https://github.com/caronc/apprise/wiki/Troubleshooting#special-characters-and-url-conflicts)) or if the channel belongs to you already, you don't even need to specify the `user_id/` at all, Apprise will use this by default anyway. Thus your other option is just to put in the `channel_name` only.
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| user | Yes | This is the User ID associated with your Spontit account. It can be found on your [Spontit Profile page](https://spontit.com/profile).
| apikey | Yes | This is the API key you generated for your Spontit account. It can be found (and generated if it doesn't already exist) [here](https://spontit.com/secret_keys).
| channel_id | No | A Channel you wish to notify (vs just sending a notification to yourself).
| channel_id | No | A Channel you wish to notify _that you created_.
| subtitle | No | The subtitle of your push. Only appears on iOS devices.
#### Example
@ -30,9 +28,11 @@ Send a Spontit notification to all devices associated with a project:
# Assume:
# - our {user} is user28635710302
# - our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise spontit://user28635710302@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise -t "Test Message Title" -b "Test Message Body" \
spontit://user28635710302@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
# Override the subtitle (Mac users only) by doing the following:
# You must use URL encoded strings, below the spaces are swapped with %20
spontit://myuser@myapi?subtitle=A%20Different%20Subtitle
apprise -t "Test Message Title" -b "Test Message Body" \
spontit://myuser@myapi?subtitle=A%20Different%20Subtitle
```