Interactive bots (beta)
- Get all streams
- Get subscribed streams
- Add subscriptions
- Remove subscriptions
- Get topics in a stream
- Create a stream
- Get stream ID
Zulip's API has a powerful framework for interactive bots that react to messages in Zulip. This page documents how to run a bot implemented using that framework, both on your laptop for quick testing as well in a production server environment.
On this page you'll find:
This guide will show you how to run an existing Zulip bot
Note: Please be considerate when testing experimental bots on public servers such as chat.zulip.org.
pip install zulip_bots to install the package.
Hint: Do you want to install the latest development version? Check out this guide.
Register a new bot user on the Zulip server's web interface.
Download the bot's
zuliprc configuration file to your computer.
~/Downloads/zuliprc(depends on your browser and OS).
Start the bot process.
zulip-run-bot <bot-name> --config-file ~/zuliprc-my-bot(using the path to the
zuliprcfile from step 3).
Check the output of the command. It should include the following line:
INFO:root:starting message handling...
Congrats! Your bot is running.
To talk with the bot, mention its name
You can now play around with the bot and get it configured the way you like. Eventually, you'll probably want to run it in a production environment where it'll stay up, by deploying it on a server using the Zulip Botserver.