Ensembl/ensembl-hive

How to connect eHive to Slack
=============================

---------

> With this tutorial, our goal is to explain how to configure eHive and Slack
to be able to report messages to a Slack channel.

> First of all, you obviously need to have a Slack team. You or someone else
will have to be allowed to configure Apps.

---------

1. Let's first add the "Incoming WebHooks" app to your team

   1. In the main Slack menu select "Apps & Custom Integrations"

   2. Find "Incoming WebHooks" via the search box and select it

   3. You should be on a page that gives an introduction about WebHooks and
lists the teams you belong too. Somebody may have already configured some
WebHooks for your team.

      1. If it is the case, click on the "Configure" button next to your team
  name and then "Add Configuration"

      2. Otherwise, click on the "Install" button next to your team name

2. Let's now configure a webhook to use with eHive

   1. You first need to choose the channel eHive will write too. Although
the Slack API allows to override the channel and thus use a single webhook
to post to different channels, we advice to configure 1 webhook per channel

   2. Click "Add Incoming WebHooks Integration"

   3. The page now shows advanced configuration for the integration. The most
important here is the "Webhook URL". This is what eHive needs

   4. If you scroll down to "Integration Settings" you can give a description
for the WebHook, change its name and emoji. Note that the latter can be
overriden in the Runnable SlackNotification

3. Use the WebHook in eHive

   1.  Define the `EHIVE_SLACK_WEBHOOK` environment variable when running your
   beekeeper

   2. Configure the `slack_webhook` parameter in the SlackNotification Runnable