zulip/templates/zerver/help/add-a-bot-or-integration.md

1.5 KiB

Add a Bot or Integration

Bots and integrations are features that are accesible to all members of an organization.

To Add a Bot

{!go-to-the.md!} Your Bots {!settings.md!}

  1. On this page, under the Add a New Bot view, you can enter a name, an email, and optionally an avatar for your bot. Then click the Create Bot button to create your bot.

    Bots page

  2. An entry such as the following should appear above the Add a New Bot view, confirming the creation of your bot.

    Example bot

  3. You now have access to your bot's API key and API configuration file (.zuliprc) which you will need for integrations that you would like to use with this bot. You can click on the download icon (Download icon) to download your .zuliprc file.

To Add an Integration

There is a full list of integrations and the directions to add them on the Integrations page. You can access this page by following the given instructions.

  1. Click the cog () in the upper right corner of the right sidebar.

  2. Next, select Integrations from the dropdown that appears.

    Integrations dropdown

  3. This will open up the Integrations page which contains a full list of all the integrations currently supported by Zulip. Click on the integration you would like to use and follow the instructions on the page that you are redirected to.