Follow the "Getting Started with Hubot" section of the
Hubot README to create your Hubot.
You'll have a new directory from which bin/hubot
starts a vanilla Hubot instance with the shell
backend.
npm install --save hubot-zulip
On your {{ settings_html|safe }}, create a bot account. Note its username, API key and full name; you will use them on the next step.
HUBOT_ZULIP_SITE={{ external_api_path_subdomain }} HUBOT_ZULIP_BOT=hubot-bot@example.com HUBOT_ZULIP_API_KEY=your_key bin/hubot --adapter zulip --name "myhubot"
The bot account email address and API key are passed to Hubot via environment variables
HUBOT_ZULIP_BOT
and HUBOT_ZULIP_API_KEY
. The --name
parameter must match
the name you gave the bot on the settings page.
Hubot will automatically listen for commands on all public streams. You can also invite Hubot to invite-only streams.
To test your Hubot installation, send it an @-notification with a basic command, for example
@Hubot pug me
, which should produce a result like this:
Source code for the hubot-zulip adapter is available on GitHub.