GROWI Developers Wiki

{{pagename}} - {{sitename}}

kaori

kosei-n

# 概要

Slack bot のセットアップは、管理者にとってはオールインワンな解で、かつ GROWI チームとしてもおすすめしていい機能
他方、通知だけに着目するといろんな選択肢がある。
- Slack bot
- Slack incoming webhook
- Mattermost incoming webhook
- IFTTT

さらに、手段の選択と設定のマニュアルだけでなく、User Trigger Notification と Global Notification の説明や設定のマニュアルも必要。
Slack bot の設定

- オフィシャル bot のセットアップ
- カスタム bot のセットアップ(non-proxy)
- カスタム bot のセットアップ(proxy)

上記は図を用意して違いを説明する。


大項目を、「Slack 連携」と「外部ツールへの通知」にする?

## Slack 連携
- 連携手法の種類の説明
  - bot 3種 or incoming webhook のそれぞれのメリデメ(v4.3 以降のおすすめは bot、みたいな案内をする)
  - bot のセットアップ
       - 3種それぞれ、メリデメとともに説明
       - Custom bot 
           - slack appでのbot新規作成方法
           - スコープの設定方法
           - 各RequestURLのセット方法
           - botをslackへインストールし、コマンドを叩けるところまで
  - incoming webhook のセットアップ
- Slack bot でできること
  - 通知 → 外部ツールへの通知内に飛ばす
  - ワークスペース内の全文検索(TBD)
  - 複数ワークスペースの横断検索(TBD)
  - Slack ログの記録(TBD)
## 外部ツールへの通知
 - 通知手段の種類の説明
      - Slack bot or Slack/Mattermost incoming webhook or IFTTT
      - Slack bot のセットアップ(おすすめ) → Slack 連携内コンテンツに飛ばす
      - Slack/Mattermost incoming webhook のセットアップ
      - IFTTT のセットアップ
- 通知の種類と設定
  - ~~incoming webhook~~(Slack連携の項目に記述する)
  - User Trigger Notification
  - Global Notification 


## マイルストーン
- 現状
    - 「Slack/Mattermost への通知」項目が存在する。
- マイルストーン1
    - 「Slack連携」、「外部ツールへの通知」項目を新たに作成し、「Slack/Mattermost への通知」の内容が「Slack連携」や「外部ツールへの通知」の適切なタイトルの下に移動される。[Custom bot non-proxy]
- マイルストーン2
    - マイルストーン2で補えなかった「内容が空白の部分」にbot関連の説明が追加される(TBD以外)
- マイルストーン3
    - 機能が追加され次第、TBDの部分が記述される。


### :warning: 注意
TBD のページやヘッダーは作りすぎないほうがいいので、何かページを作る・ヘッダーを追加するといったタスクのゴールも「追加はするけど一旦コメントアウトの状態」にするのが好ましい。





Docs

概要

Slack 連携

外部ツールへの通知

マイルストーン

⚠️ 注意