Created Notify_kumulos (markdown)

Chris Caron 2019-09-11 22:18:32 -04:00
parent a31f550031
commit 14f2686138

30
Notify_kumulos.md Normal file

@ -0,0 +1,30 @@
## Kumulos
* **Source**: https://kumulos.com/
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 240 Characters per message
### Account Setup
To use this plugin, you must have a Kumulos account set up. Add at least 1 client and link it with your phone using the phone app (using your _Companion App_ option in the profile menu area):
- [Android App](https://play.google.com/store/apps/details?id=com.kumulos.companion)
- [iOS](https://apps.apple.com/us/app/kumulos/id1463947782)
To use Kumulos, you will need to acquire your _API Key_ and _Server Key_. Both of these are accessible via the Kumulos Dashboard.
### Syntax
Valid syntax ia as follows:
* `kumulos://{ApiKey}/{ServerKey}`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| ApiKey | Yes | The _API Key_ associated with your Kumulos account.
| ServerKey | Yes | The _Server Secret_ associated with your Kumulos account.
#### Example
Send a Kumulos Notification:
```bash
# Assuming our {APIKey} is 8b799edf-6f98-4d3a-9be7-2862fb4e5752
# Assuming our {ServerKey} is aNe8IVQvUay79KEOt8jEh2GPWOwRKAXG+lP7
apprise kumulos://8b799edf-6f98-4d3a-9be7-2862fb4e5752/aNe8IVQvUay79KEOt8jEh2GPWOwRKAXG+lP7
```