zulip/templates/zerver/integrations/codebase.md

Zulip Codebase integration

Get Codebase notifications in Zulip!

{start_tabs}

1. Create the channels you’d like to use for Codebase notifications. There will be two types of notification messages: issue-related and commit-related.

2. {!create-an-incoming-webhook.md!}

3. {!download-python-bindings.md!}

4. Install the requirements for the integration script with:

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

5. {!change-zulip-config-file.md!}

   Also add ZULIP_TICKETS_STREAM_NAME and ZULIP_COMMITS_STREAM_NAME with the names of the channels you created in step 1.

6. 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
   

   !!! tip ""

    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`.
   

7. Run the /usr/local/share/zulip/integrations/codebase/zulip_codebase_mirror script.

   !!! tip ""

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

{end_tabs}

{!congrats.md!}