Created Notify_join (markdown)

lead2gold 2017-11-29 20:22:19 -05:00
parent 9ad837e740
commit 6ac19115df

39
Notify_join.md Normal file

@ -0,0 +1,39 @@
## Join Notifications
* **Source**: https://joaoapps.com/join/
* **Icon Support**: Yes
* **Message Format**: Text
* **Message Limit**: 1000 Characters per message
To use this plugin:
1. Ensure your browser allows popups and visit [joinjoaomgcd.appspot.com](https://joinjoaomgcd.appspot.com/).
2. To register you just need to allow the page to link with your Google Profile. The good news is it doesn't ask for anything too personal.
3. Download the app for your phone from the [Android Store here](https://play.google.com/store/apps/details?id=com.joaomgcd.join)
### Syntax
Valid syntax is as follows:
* **join**:://**{apikey}**/**{device_id}**
* **join**:://**{apikey}**/**{device_id1}**/**{device_id2}**/**{device_idN}**
Groups can be referenced like this (the *group.* part is optional):
* **join**:://**{apikey}**/group.**{group_id}**
* **join**:://**{apikey}**/group.**{group_id1}**/group.**{group_id2}**/group.**{group_idN}**
* **join**:://**{apikey}**/**{group_id}**
* **join**:://**{apikey}**/**{group_id1}**/**{group_id2}**/**{group_idN}**
You can freely mix and match these combinations as well:
* **join**:://**{apikey}**/**{device_id}**/**{group_id}**
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| apikey | Yes | The api key associated with your Join account.
| device_id | No | The device identifier to send your notification to.
| group_id | No | The group identifier to send your notification to.
#### Example
Send a Join notification to all of our configured devices:
```bash
# Assuming our {apikey} is abcdefghijklmnop-abcdefg
# Assume we're sending to the group: all
notify.py join://abcdefghijklmnop-abcdefg/group.all
```