extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_zulip
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
3 Notify_zulip
Chris Caron edited this page 2020-12-21 20:02:23 -05:00
Table of Contents

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: