github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Created Notify_spontit (markdown)

master
Chris Caron 2020-07-21 17:43:07 -04:00
parent e44dd3d23e
commit e73bcd4d9d
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Notify_spontit.md Normal file

@ -0,0 +1,34 @@
## Spontit Notifications
* **Source**: https://spontit.com
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 100 Characters per Message
1. Visit https://spontit.com to create your account.
2. To acquire your `{user}`: Visit your profile at https://spontit.com/profile and take note of your User ID here. It will look something like: `user12345678901`
3. To acquire your `{apikey}`: Generate an API key at https://spontit.com/secret_keys (if you haven't already done so).
### Syntax
Channels are optional; if no channel is specified then you are just personally notified.
* `spontit://{user}@{apikey}`
* `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).
#### Example
Send a Spontit notification to all devices associated with a project:
```bash
# Assume:
# - our {user} is user28635710302
# - our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise spontit://user28635710302@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
```