Skip to content

Zulip Chat

URL Format

The shoutrrr service URL should look like this:

zulip://botmail:botkey@host/?stream=stream&topic=topic

URL Fields

  • BotMail - Bot e-mail address (Required)
    URL part: zulip://botmail:botkey@host:port/

  • BotKey - API Key (Required)
    URL part: zulip://botmail:botkey@host:port/

  • Host - API server hostname (Required)
    URL part: zulip://botmail:botkey@host:port/

Query/Param Props

Props can be supplied through the URL using ?key=value&key=value etc.

  • Stream
    Default: empty

Example

Note

Since botmail is a mail address you need to URL escape the @ in it to %40.

zulip://my-bot%40zulipchat.com:[email protected]?stream=foo&topic=bar

Released under the MIT License