zulip

command
v0.8.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 24, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

README

Zulip plugin

Posts each alert to a Zulip stream topic as a bot.

Kind notification_channel, ability read, outbound hosts: zulip.example.com placeholder, see the self-hosted note in docs/plugins-first-party.md.

Config

Plugin-wide, non-secret, passed at install with --config:

{"base_url": "https://zulip.example.com", "stream": "ops", "topic": "alerts"}
Field Required Meaning
base_url yes Your Zulip server, https only
stream yes Stream name
topic no Topic, default alerts
allow_http no Permit plain http for a lab server

Channel target

The channel's target field holds <bot email>:<api key> (from the bot's settings in Zulip). It is sealed like any channel credential and sent per call. The plugin never stores or logs it.

levelrail-cli plugins install --manifest plugin.yaml --signature plugin.sig --config config.json --approve read
levelrail-cli channels create --name ops-zulip --kind plugin:zulip --notify-url bot@zulip.example.com:API_KEY

Behaviour

  • 401 and 403 are permanent ("authentication failed").
  • 429 waits out a short Retry-After and retries, otherwise reports retryable.
  • 5xx and network errors retry twice, then report retryable.
  • Other 4xx are permanent and the response excerpt is shown with the credential redacted.

Build and sign locally with scripts/plugins-build.sh all zulip. Tests: go test ./plugins/zulip.

Documentation

Overview

Command zulip posts alerts to a Zulip stream topic as a bot.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL