【旧】Slackと連携する

5/29(水)19時(5月最後のアップデート)以降は本ページの旧形式のSlack連携機能を削除する予定です。新しいSlack連携に関する設定方法は「Slackと連携する」をご確認ください。
BYARDはSlackと連携することができます。Slackと連携することで、案件のワークを進める中でシステムから届く通知が、メールだけでなくSlackでも受け取ることができます。

■Slack連携の仕組み

BYARD上の案件やワークで動きがあったときに、Slackのチャンネルに通知を送ります。通知先となるチャンネルは、Slack側で発行される「Webhook URL」の接続先が対象となります。
「Webhook URL」は、チャンネルごとに発行します。発行したURLをテンプレートもしくは案件に登録すると、該当のテンプレート、アンケート内で動きがあったときに、通知が接続先のチャンネルに届きます。 また、メッセージや担当者のアサイン連絡など「@個人」のメンションを受け取りたい場合は、個人設定にも「Webhook URL」を登録する必要があります。 テンプレート・案件に登録する「Webhook URL」は業務の関係者が集まるチャンネルに接続個人設定に登録する「Webhook URL」は各自のダイレクトメッセージに接続することで、チームと個人へ通知の出し分けができます。
💡
個人設定に「Webhook URL」を登録すると、対象のユーザーが関わる案件やワークで動きがあった際に、接続先のチャンネルに通知が届きます。オープンチャンネルの「Webhook URL」を登録すると、チャンネルとは関係ない業務の通知が届く可能性がありますのでご注意ください。 BYARDとしては、個人設定にはダイレクトメッセージやプライベートチャンネルなど、特定の人しか見れないチャンネルの「Webhook URL」を登録することを推奨しています。 【想定役割】 テンプレート・案件に登録:チームに進捗をアナウンス 個人設定に登録     :自分宛に進捗をアナウンス

■通知方法の種類

通知方法は2種類あります。

1. テンプレート・案件ごとに通知

テンプレートや案件内で動きがあったときに、「Webhook URL」の接続先となるチャンネルに通知が届きます。

2. 個人宛に通知

自身が関わるテンプレートや案件内で動きがあったときに、「Webhook URL」の接続先となるチャンネルに通知が届きます。こちらはユーザーごとに自身で設定を行う必要があります。
⚠️
個人設定で登録する前に、組織設定で「Webhook URL」の登録が必要です。

■受信するメッセージの種類

Slack連携後に通知が届くメッセージの内容は以下の通りです。
通知メッセージ通知タイミング
案件が開始されましたテンプレートから案件が開始されたとき
担当者・共有者に設定されました・テンプレート、案件、ワークの担当者や共有者に設定されたとき ・テンプレートから案件が開始されたとき(個人宛て)
ワークが完了しました自分が担当者のワークを別のユーザーが完了にしたとき
ワークの開始準備ができました前のワークが完了したとき
メッセージが届きました(※)ワーク内のチャットで自分宛てにメンションでメッセージが送られたとき
案件が完了しました案件が完了したとき
⚠️
ワーク内のチャットにおけるメンション通知は、個人宛の通知になるため、案件に「Webhook URL」を登録するだけでは通知が届きません。メンション通知を受け取るためには、個人設定で「Webhook URL」と「Member ID」を設定する必要があります。 設定方法につきましては、本ページの「2-2. 個人に通知する場合」をご確認ください。

■Slack連携の流れ

1. Slackの「Webhook URL」を取得する

  1. Slack api」で新しいアプリを作成する
    1. Slack api」のページにアクセスし、[Create New App]をクリックします。
  1. [From scratch]を選択する
  1. アプリ名とワークスペースの選択する
    1. 「App Name」に任意のアプリ名を入力します。
    2. 「Pick a workspace to develop your app in」で連携するワークスペースを選択します。
    3. [Create App]をクリックします。
    4. 💡
      [Create App]をクリック後、そのままステップ5の「「Incoming Webhook」を有効化」に進む場合があります。
  1. 「Incoming Webhook」を有効化するページを開く
    1. [Add features and functionality]をクリックします。
    2. [Incoming Webhooks]をクリックします。
  1. 「Incoming Webhook」を有効化する
    1. 「Active Incoming Webhooks」を[ON]にします。
  1. ワークスペースWebhookを追加する
    1. [Add New Webhook to Workspace]をクリックします。
  1. 連携するチャンネルを選択する
    1. 連携するチャンネルを選択します。
      1. 💡
        選択肢に希望のチャンネルが見つからない場合は、チャンネル名を検索してください。
    2. [許可する]をクリックします。
    3. ⚠️
      「〇〇にはインストールするボットユーザーがありません」のエラーが表示され設定ができない場合は、アプリ名に日本語を利用している、もしくは空白になっていることが原因となっている可能性があります。
      下記の手順でアプリ名を設定してください。
      1. [features]>[App Home]を選択します。
      1. [Edit]をクリックします。
      1. アプリ名を設定します。
        1. 「Display Name」を入力します。
        2. 「Default username」を入力します(半角英数字)。
        3. [Add]をクリックします。
      1. [features]>[Incoming Webhooks]を選択します。
      1. [Add New Webhook to Workspace]をクリックします。
        1. 以降は「7.連携するチャンネルを選択する」の操作に戻ります。
  1. 「Webhook URL」をコピーする
    1. チャンネル連携後、「Webhook URL」が表示されます。表示されているURLをコピーします。

2. 取得した「Webhook URL」をBYARDに登録する

取得したWebhook URLをBYARDに登録します。テンプレート・案件ごとに通知するか、個人単位で通知するかによって登録する場所が異なります。

2-1.テンプレート・案件ごとに通知する場合

  1. テンプレート・案件を開く
    1. 通知を送りたいテンプレート、案件を開きます。
  1. 基本情報メニューを開く
    1. フッターの基本情報メニューを開きます。
  1. [Webhook URL]に取得したURLを入力する
    1. 取得した「Webhook URL」をそのまま入力します。
       
      💡
      他のチャンネルに通知設定をするときは、Slackの「Incoming Webhooks」のページよりURLを追加してください。

2-2. 個人に通知する場合

  1. [組織設定]を開く
    1. Webhook URLのコピー後、BYARDの[組織設定]を開きます。
  1. [通知設定]タブを開く
    1. [通知設定]をクリックします。
  1. [Slack]に「Webhook URL」を登録する
    1. 取得したWebhook URLを入力します
    2. [通知設定保存]をクリックします
    3. ⚠️
      組織設定に登録する「Webhook URL」は、コピーしたURLの/services/の一つ後ろの「/(スラッシュ)」で囲まれている部分までを利用します。
      登録する範囲:https://hooks.slack.com/services/〇〇/
      ⚠️
      「組織設定」は、「エディター(オーナー)」「エディター(管理者)」の権限を持つユーザーが設定できます。メニューが表示されていない場合は、上記権限を持つ管理者に設定を依頼してください。
 
  1. 個人設定を開く
    1. メニューの一番下にあるユーザー名をクリックします。
  1. [通知設定]タブを開く
    1. [通知設定]をクリックします。
  1. [Slack]に「Webhook URL」を登録する
    1. 「Webhook URL」を入力します
    2. Slackの「Member ID」を入力します
    3. [通知設定保存]をクリックします
    4. ⚠️
      入力する「Webhook URL」は、省略されていないURLを入力してください。
      💡
      「Member ID」は、Slackの画面から確認できます。
      [Slackのプロフィール]>[設定(3点リーダー)]と進み、[メンバーIDをコピー]をクリックすることで、「Member ID」を取得できます。
      💡
      個人宛に通知をする場合は、ユーザーごとに自身で「Webhook URL」の発行とBYARDに登録を行う必要があります。 事前に組織設定に「Webhook URL」の登録が必要ですが、未登録の場合はBYARDの管理者権限を持つ担当者にご確認ください。

■連携するSlackチャンネルを追加する

他の案件やテンプレートを別のSlackチャンネルに新しく連携する際は、すでに作成したアプリから「Webhook URL」を追加することで、簡単に設定をすることができます。

「Webhook URL」追加の流れ

  1. Slack api」のアプリ管理画面を開く
    1. Slack api」のページにアクセスし、作成済みのアプリ名をクリックします。
  1. 「Incoming Webhoooks」のページを開く
    1. 左のメニューから[Incoming Webhooks]をクリックします。
  1. ワークスペースWebhookを追加する
    1. [Add New Webhook to Workspace]をクリックします。
以降の流れは初めてチャンネル連携をしたときと同様に、「連携するチャンネルの選択」→「BYARDの案件、テンプレートにWebhook URLの登録」の順で設定を進めます。
詳細は本ページの「6. ワークスペースWebhookを追加する」からご確認ください。
⚠️
別のSlackワークスペースと連携する場合は、一番最初のアプリの作成から設定を行ってください。
 
📎
関連記事