> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryassist.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Zulip

## How it Works

The Zulip Connector pulls in all streams and topics based on the permissions assigned to the bot user.

## Setting Up

### Authorization

1. **Understand Zulip bot authentication**
   ASSIST AI connects with Zulip through a Zulip Bot, which is authenticated using the `zuliprc` configuration format. For more details directly from Zulip, refer to the following documentation:
   * [https://zulip.com/api/running-bots](https://zulip.com/api/running-bots)
   * [https://zulip.com/api/configuring-python-bindings](https://zulip.com/api/configuring-python-bindings)
2. **Create a Zulip Bot**
   Begin by setting up a new Zulip Bot in your Zulip workspace.
3. **Copy the zuliprc contents**
   Copy the bot's authentication information (the `zuliprc` contents) as indicated by the red arrow in the screenshot below. Keep this copied text on hand to provide to ASSIST AI in the next step.

## Indexing

1. **Open the Zulip connector**
   Navigate to the Admin Panel and select the **Zulip Connector**.
2. **Paste the zuliprc value**
   In Step 1, paste in the `zuliprc` content you copied earlier.
3. **Get your Realm/URL**
   Locate your Zulip Realm and URL information as shown below.
4. **Enter the Realm and URL**
   In Step 2, provide the corresponding values for the **Realm** and **URL** fields.