Skip to content

Notify_zulip

Jump to bottom
Chris Caron edited this page Dec 22, 2020 · 3 revisions

Zulip Notifications

  • Source: https://zulipchat.com/
  • Icon Support: No
  • Message Format: Text
  • Message Limit: 10000 Characters per message

Account Setup

To use this Zulip, you must have a Zulip Chat bot defined; See here for more details. At the time of writing this plugin the instructions were:

  1. From your desktop, click on the gear icon in the upper right corner.
  2. Select Settings.
  3. On the left, click Your bots.
  4. Click Add a new bot.
  5. Fill out the fields, and click Create bot.

If you know your organization {ID} (as it's part of your zulipchat.com url), then you can also access your bot information by visiting: https://ID.zulipchat.com/#settings/your-bots

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}/{stream}
  • zulip://{botname}@{organization}/{token}/{stream1}/{stream2}/{streamN}
  • zulip://{botname}@{organization}/{token}/{email}
  • zulip://{botname}@{organization}/{token}/{email1}/{email2}/{emailN}

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}/{stream1}/{email1}/

Parameter Breakdown

Variable Required Description
organization Yes The organization you created your webhook under. The trailing part of the organization reading .zulipchat.com is not required here, however this is gracefully handled if specified.
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.
stream No A stream to notify.

Example

Send a Zulip notification to default #general (default) stream:

# Assuming our {organization} is apprise
# Assuming our {token} is T1JJ3T3L2
# Assuming our {botname} is goober
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   zulip:///goober@apprise/T1JJ3T3L2

Send a Zulip notification to the #support stream:

# 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

Quick Links:

Clone this wiki locally