Zulip Codebase integration

Get Codebase notifications in Zulip!

Instructions for all platforms

Create the channels you’d like to use for Codebase notifications. There will be two types of notification messages: issue-related and commit-related.
Create a bot for Codebase. Make sure that you select Incoming webhook as the Bot type.
Download and install our Python bindings and example scripts on the system where the Codebase integration script will be run from.

Install the requirements for the integration script with:

pip install /usr/local/share/zulip/integrations/codebase/requirements.txt

Open /usr/local/share/zulip/integrations/codebase/zulip_codebase_config.py with your favorite editor, and change the following lines to specify the email address and API key for your Codebase bot:
```
ZULIP_USER = "codebase-bot@chat.zulip.org"
ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
ZULIP_SITE = "https://chat.zulip.org"
```
Also add ZULIP_TICKETS_STREAM_NAME and ZULIP_COMMITS_STREAM_NAME with the names of the channels you created in step 1.
Go to your Codebase settings, and click on My Profile. Under API Credentials, you will find your API key and username. Edit the following lines in zulip_codebase_config.py to add your Codebase credentials:
```
CODEBASE_API_USERNAME = "zulip-inc/user-name-123"
CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
```
Before your first run of the script, you may also want to configure the integration to mirror some number of hours of prior Codebase activity, e.g., CODEBASE_INITIAL_HISTORY_HOURS = 10.
Run the /usr/local/share/zulip/integrations/codebase/zulip_codebase_mirror script.

This script can be restarted, and it will resume from when it was last running.

You're done! Your Codebase notifications may look like this:

Codebase bot message

Logos are trademarks of their respective owners. None of the integrations on this page are created by, affiliated with, or supported by the companies represented by the logos.