Skip to main content

Zulip

The Zulip trigger lets you send container update notifications to Zulip streams or private direct messages using the Zulip REST API.

⚙️ Configuration Variables​

WUD_TRIGGER_ZULIP_{trigger_name}_APIKEY
Requiredstring

Zulip bot API key

WUD_TRIGGER_ZULIP_{trigger_name}_BOTEMAIL
Requiredstring

Zulip bot email address

WUD_TRIGGER_ZULIP_{trigger_name}_TO
Requiredstring

Target stream name (for stream) or user email / ID (for direct)

WUD_TRIGGER_ZULIP_{trigger_name}_URL
Requiredurl

Zulip server or organization base URL

Allowed values:Valid HTTP/HTTPS Zulip organization URL (e.g. https://zulip.example.com)
WUD_TRIGGER_ZULIP_{trigger_name}_DISABLETITLE
Optionalbooleandefault: false

Whether to omit the notification title in message bodies

WUD_TRIGGER_ZULIP_{trigger_name}_TOPIC
Optionalstringdefault: WUD Updates

Topic name for stream messages

WUD_TRIGGER_ZULIP_{trigger_name}_TYPE
Optionalenumdefault: stream

Message destination type: stream or private direct message

Allowed values:`stream`, `direct`
info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

🚀 Examples​

Stream Notification​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_ZULIP_MAIN_URL=https://zulip.example.com
      - WUD_TRIGGER_ZULIP_MAIN_BOTEMAIL=wud-bot@zulip.example.com
      - WUD_TRIGGER_ZULIP_MAIN_APIKEY=secret_api_key_here
      - WUD_TRIGGER_ZULIP_MAIN_TYPE=stream
      - WUD_TRIGGER_ZULIP_MAIN_TO=infrastructure
      - WUD_TRIGGER_ZULIP_MAIN_TOPIC=Docker Updates