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

Updated Notify_zulip (markdown)

master
Chris Caron 2020-12-21 20:02:23 -05:00
parent ffefac2f2b
commit 2333b634c0
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Notify_zulip.md

@ -19,15 +19,15 @@ Upon creating a bot successfully, you'll now be able to access it's API Token.
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **zulip**://**{botname}**@**{organization}**/**{token}**/ * **zulip**://**{botname}**@**{organization}**/**{token}**/
* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel}** * **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream}**
* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel1}**/**{channel2}**/**{channelN}** * **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream1}**/**{stream2}**/**{streamN}**
* **zulip**://**{botname}**@**{organization}**/**{token}**/**{email}** * **zulip**://**{botname}**@**{organization}**/**{token}**/**{email}**
* **zulip**://**{botname}**@**{organization}**/**{token}**/**{email1}**/**{email2}**/**{emailN}** * **zulip**://**{botname}**@**{organization}**/**{token}**/**{email1}**/**{email2}**/**{emailN}**
**Note**: If neither a **{channel}** or **{email}** is specified then by default the channel **general** is notified. **Note**: If neither a **{stream}** or **{email}** is specified then by default the stream **general** is notified.
You can also mix and match the entries above too: You can also mix and match the entries above too:
* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel1}**/**{email1}**/ * **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream1}**/**{email1}**/
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
@ -36,10 +36,10 @@ You can also mix and match the entries above too:
| token | Yes | The API token provided to you after creating a *bot* | token | Yes | The API token provided to you after creating a *bot*
| botname | Yes | The botname associated with the API Key. The `-bot` portion of the bot name is not required, however this is gracefully handled if specified. | botname | Yes | The botname associated with the API Key. The `-bot` portion of the bot name is not required, however this is gracefully handled if specified.
| email | No | An email belonging to one of the users that have been added to your organization the private message. | email | No | An email belonging to one of the users that have been added to your organization the private message.
| channel | No | A channel to notify. | stream | No | A stream to notify.
#### Example #### Example
Send a Zulip notification: Send a Zulip notification to default #general (default) stream:
```bash ```bash
# Assuming our {organization} is apprise # Assuming our {organization} is apprise
# Assuming our {token} is T1JJ3T3L2 # Assuming our {token} is T1JJ3T3L2
@ -47,3 +47,12 @@ Send a Zulip notification:
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
zulip:///goober@apprise/T1JJ3T3L2 zulip:///goober@apprise/T1JJ3T3L2
``` ```
Send a Zulip notification to the #support stream:
```bash
# Assuming our {organization} is apprise
# Assuming our {token} is T1JJ3T3L2
# Assuming our {stream} is #support
apprise -vv -t "Test Message Title" -b "Test Message Body" \
zulip:///apprise/T1JJ3T3L2/support
```