Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Zulip

Schemeszulip://
Cargo featureservice-zulip
Servicehttps://zulipchat.com/
Body formatstext (first is the default)
Attachmentsno
Title length60 characters
Body length10,000 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedno

URL formats

{schema}://{botname}@{organization}/{token}
{schema}://{botname}@{organization}/{token}/{targets}

{schema} is one of zulip://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{botname}Bot Namestringyesmust match ^[A-Z0-9_-]{1,32}$
{organization}Organizationstringyesmust match ^[A-Z0-9_-]{1,32}$
{target_stream}Target Streamstringno
{target_user}Target Useremailno
{targets}Targetslistnoany of target_stream, target_user; separated by /
{token}Tokenstringyessecret; must match ^[A-Z0-9]{32}$

Query parameters

ParameterMeaningTypeDefaultNotes
toTargetslistsets {targets}
tokenTokenstringsets {token}

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

zulip://bot-name-bot@mercurio/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
zulip://botname@mercurio/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/%23mystream
zulip://botname@mercurio/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/channel2/channel1
zulip://botname@mercurio/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/?to=channel1/channel2%23chan3
zulip://botname@mercurio/streamA?token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
zulip://botname@mercurio/?token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&to=channel1

Rejected URLs:

zulip://
zulip://:@/
zulip://mercurio
zulip://botname@mercurio

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'zulip://bot-name-bot@mercurio/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'

Notes

Zulip (zulip://): messages to Zulip streams and users through a bot.