diff --git a/Notify_zulip.md b/Notify_zulip.md index 459ec57..144bbbc 100644 --- a/Notify_zulip.md +++ b/Notify_zulip.md @@ -19,15 +19,15 @@ Upon creating a bot successfully, you'll now be able to access it's API Token. ### Syntax Valid syntaxes are as follows: * **zulip**://**{botname}**@**{organization}**/**{token}**/ -* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel}** -* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel1}**/**{channel2}**/**{channelN}** +* **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream}** +* **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream1}**/**{stream2}**/**{streamN}** * **zulip**://**{botname}**@**{organization}**/**{token}**/**{email}** * **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: -* **zulip**://**{botname}**@**{organization}**/**{token}**/**{channel1}**/**{email1}**/ +* **zulip**://**{botname}**@**{organization}**/**{token}**/**{stream1}**/**{email1}**/ ### Parameter Breakdown | 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* | 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. -| channel | No | A channel to notify. +| stream | No | A stream to notify. #### Example -Send a Zulip notification: +Send a Zulip notification to default #general (default) stream: ```bash # Assuming our {organization} is apprise # Assuming our {token} is T1JJ3T3L2 @@ -47,3 +47,12 @@ Send a Zulip notification: apprise -vv -t "Test Message Title" -b "Test Message Body" \ 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 +```