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 provides a set of tools that allows interacting with its API more easily, called the Python bindings. One of the most notable use cases for these bindings are bots developed using Zulip's bot framework.
In order to use them, you need to configure them with your API key and other settings. There are two ways to achieve that:
.zuliprc, located in your home directory.
.zuliprc file is a plain text document that has the same format as
Microsft Windows INI files. It looks like this:
[api] key=<api key from the web interface> email=<your email address> site=<your Zulip server's URI> ...
The keys you can use in this file (and their equivalent environment variables) can be found in the following table:
||Yes||API key, which you can get through Zulip's web interface.|
||Yes||The email address of the user who owns the API key mentioned above.|
||No||URL where your Zulip server is located.|
||No||Path to the SSL/TLS private key that the binding should use to connect to the server.|
The public counterpart of
||No||Path where the server's PEM-encoded certificate is located. CA certificates are also accepted, in case those CA's have issued the server's certificate. Defaults to the built-in CA bundle trusted by Python.|
Allows connecting to Zulip servers with an invalid SSL/TLS
certificate. Please note that enabling this will make the HTTPS
connection insecure. Defaults to