Zulip Notifications

Overview

• Source: https://zulipchat.com/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 10000

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 syntax is 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.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

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