Zulip Chat¶

URL Format¶

The shoutrrr service URL should look like this:

zulip://bot-mail:bot-key@zulip-domain/?stream=name-or-id&topic=name

Stream and topic are both optional and can be given as parameters to the Send method:

  sender, __ := shoutrrr.CreateSender(url)

  params := make(types.Params)
  params["stream"] = "mystream"
  params["topic"] = "This is my topic"

  sender.Send(message, &params)

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

An example service URL would look like:

zulip://my-bot%40zulipchat.com:correcthorsebatterystable@example.zulipchat.com?stream=foo&topic=bar