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

Created Notify_gitter (markdown)

master
Chris Caron 2019-03-26 21:43:14 -04:00
parent 011da39606
commit 4d09812bad
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Notify_gitter.md Normal file

@ -0,0 +1,37 @@
## Gitter Notifications
* **Source**: https://gitter.im/
* **Icon Support**: Yes
* **Message Format**: Markdown
* **Message Limit**: 32768 Characters per message
### Account Setup
Gitter isn't to difficult to get yourself an account [on their website](https://gitter.im/).
From here, you just need to get your Gitter **Personal Access Token** which is as simple as visiting their [development website](https://developer.gitter.im/apps) and signing in (if you're not already). Almost immediately you should see a pop-up box providing you your token.
**Note: You can ignore the App generation feature here as it's not relevant to sending an apprise notification.
The last thing you need to know about this is you need to have already joined the channel you wish to send notifications to. The **Personal Access Token** represents you, so even if you join a channel and close out of your web browser, you're still actually a part of that channel (until you log back in and leave the channel).
Channels identify themselves as **name**/community; you only need to focus on the name. So if the channel was **apprise**/community, the channel name can be assumed to be **apprise** when using this script.
### Syntax
Valid syntaxes are as follows:
* **gitter**://**{token}**/**{room}**/
* **gitter**://**{token}**/**{room1}**/**{room2}**/**{roomN}**/
* **gitter**://**{token}**/**{room}**/?**image=Yes**
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| token | Yes | The Personal Access Token associated with your account. This is available to you after signing into their [development website](https://developer.gitter.im/apps).
| room | No | The room you want to notify. You can specify as many as you want of these on the URL.
| image | No | Send an image representing the message type prior to sending the message body. This is disabled by default.
| to | No | This is an alias to the room variable.
#### Example
Send a slack notification to our channel #nuxref:
```bash
# Assuming our {token} is abcdefghij1234567890
# Assuming our {room} is apprise/community
apprise gitter:///abcdefghij1234567890/apprise
```