新しいSlack連携と旧連携の提供終了について

■新しい連携方法の提供と旧仕様の削除の背景

旧形式のSlack連携は「IncomingWebhook」と呼ばれる仕組みを利用して、BYARDとSlackの連携を行っていました。この仕組みではBYARDとSlackを連携する際に、Slack側で特別なURLを発行し登録するという作業が都度必要になります。この仕組みでは以下の運用課題がありました。
  1. 案件やテンプレートを連携する際に、毎回URLを発行する必要があり手間がかかる
  1. 多くのURLを管理する必要がある
  1. 組織のセキュリティポリシーによっては、Slack側でURLの発行が制限されている可能性がある
  1. URLの発行方法が複雑で直感的に発行することが難しい
旧Slack連携では「IncomingWebhook」によってURLを複数用意する必要がありました
旧Slack連携では「IncomingWebhook」によってURLを複数用意する必要がありました
 
これらの課題を解消するべくSlack連携が簡単にできるアプリを開発、提供する運びとなりました。今後はURLの発行が不要となり、必要最小限のクリックのみで連携ができるようになります。
アプリによって連携をコントロールできるように。実際の作業は画面上でクリックするのみ
アプリによって連携をコントロールできるように。実際の作業は画面上でクリックするのみ
 
本対応に伴い、不要となりました旧形式の「IncomingWebhook」を用いた連携を終了させていただくことにいたしました。現在、旧来のSlack連携をご活用中のお客様におかれましては、大変お手数おかけいたしますが、新しい連携設定への切り替えのご協力をお願い申し上げます。

■変更点について

通知の内容など基本的な部分においては変更点はございません。連携の仕組みが変わることにより、下記細かい部分での変更点がございます。
  1. Slack連携の設定方法が変わります
  1. Slack上で自身宛の通知を受け取る場所が、「ダイレクトメッセージ」から「アプリの通知(BYARD App)」に変わります。Slackのメニューの[App]>[BYARD]が自身宛の通知を受け取る場所になります。
  1. 一つのストリームから複数のSlackオープンチャンネルに通知を送信することができるようになります。

旧Slack連携設定の終了スケジュールについて

旧形式のSlack連携は、以下の日時にて設定メニューをBYARDの画面上から削除いたします。 予定日:5/29(水)19時以降(5月最後のアップデート時)

旧Slack連携から新Slack連携への切り替え方法

新Slack連携と旧Slack連携の両方が設定されている環境では、ユーザーごとに通知が重複して届くことになります。そのため、新Slack連携を設定後に旧Slack連携の設定を解除していただく必要があります。大変お手数おかけいたしますが、切り替え作業のご協力を賜りますようお願い申し上げます。
 
▼設定の流れ

1. 組織設定でBYARDとSlackを連携する

管理者が行う設定です
  1. [組織設定]>[通知設定]を開く
  1. [Slackに接続する]をクリックする
  1. [許可する]をクリックする
    1. BYARDとSlackを連携する画面が表示されますので、[許可する]をクリックし連携します。連携するSlackのワークスペースは画面右上の選択メニューから変更可能です。
      💡
      「このアプリはSlackのよる承認を受けていません」と表示されますが、連携やセキュリティ上の影響は一切ございませんのでご安心ください。
       
以上で管理者が行うBYARDとSlackの連携は完了です。正常に連携がされると、接続先のSlackワークスペース名がBYARDの通知設定に表示されます。同時に、Slackにも連携完了の通知が届きます。
 

2. 個人設定でBYARDとSlackを連携する

ユーザーごとに行う設定です
  1. グローバルメニューの一番下にある[個人設定]を開く
  1. [通知設定]タブをクリックする
  1. [接続]をクリックする
    1. 💡
      接続先は「メールアドレス」と「Slackの表示名」をチェックしております。
      BYARDとSlackのメールアドレスが一致していない、Slackの表示名が設定されていない場合は連携することができません。接続できない場合は、ログインに利用しているメールアドレスとSlackの表示名をご確認ください。
      Slackの表示名の設定方法はこちらのガイドをご確認くださいませ。
       
以上でユーザーごとに行うBYARDとSlackの連携は完了です。正常に連携がされると、接続先のSlackワークスペース名と表示名がBYARDの通知設定に表示されます。同時に、Slackにも連携完了の通知が届きます。
 

3. 旧形式の連携設定を解除する

ユーザーごとに行う設定です
  1. [Webhook URL]と[Member ID]を消去し、[通知設定保存]をクリックする
    1. 通知設定の画面に表示されている旧形式の[Webhook URL]と[Member ID]の入力を消去し、設定を保存します。
 
新形式の通知のオン/オフの設定は、[New Slack]>[通知設定]から可能です。画面右側の設定は旧形式の設定であり、提供終了と共に設定場所を統合する予定です。
 

4. テンプレート・案件の連携設定を設定し直す

テンプレート・案件とSlackを接続済みの場合に限り、テンプレート・案件のオーナーが行う設定です
  1. テンプレート・案件の[基本情報]メニューを表示する
    1. テンプレート・案件のストリームを開き、[基本情報]メニューを表示します。[基本情報]はフッターメニューの一番左にあるボタンをクリックすることで表示できます。
  1. [Webhook URL]を消去する
  1. Slackチャンネルの選択メニューを開く
    1. [SlackChannels]の[+]をクリックし、Slackチャンネルの選択メニューを表示します。
  1. 連携するSlackチャンネルを選択する
    1. 連携したいSlackチャンネル名の右側にある[+]ボタンをクリックし連携します。
      ⚠️
      表示されるSlackチャンネルはオープンチャンネルのみ表示され、プライベートチャンネルは表示されません。
      💡
      同じ操作を繰り返すことで、複数のSlackチャンネルと連携することが可能です。