Slackで定期的に確認をサポートするbotアプリ「KurocoWorkflow」のインストールと利用方法

注記

想定作業時間：10分

アプリ概要説明

Slackにてメンションがついた投稿に「👍」スタンプがつけられるまで、定期的にリマインドを送るbotをKurocoにて作成しました。

• このパッケージはSlack用「確認お願いしますボット」の仕様（誰か作ってほしい）の記事にインスピレーションを得て1日で作成したものです。
• 月間3000ワークフロー程度の利用で無料枠1100円/月を超える予想です。
• こちらのパッケージをOEMで提供していただく、または改造いただいても構いません。全て管理画面で設定されたものです。不具合や要望など是非、フィードバックをください。

起動条件

下記条件にてAppが起動されます。

• @KurocoWorkflow にメンションがついていること
• 誰か宛にメンションがついていること

リマインド時間の設定

下記条件にて、メンション受けた人で「👍」または「👎」スタンプをつけてない人に定期的にDMでリマインダーが送られます。

• デフォルト：12時間毎
• 投稿内に「🔥」が記載されている場合：1時間毎（メッセージを編集して、途中から緊急にもできます）

完了条件

下記にてリマインドが完了します。

• slackのメッセージに「👍」または「👎」スタンプをつける

キャンセルの条件

下記にてリマインドがキャンセルされます。

• slackのメッセージ内に「❌」スタンプを記入する(つまり投稿者のみキャンセル可能です)

ウォッチの条件

下記にて結果がDMで共有されます。

• slackのメッセージに「👀」スタンプをつける

ワークフロー終了の条件

メンションを受けた人が全員「👍」または「👎」のリアクションをすると、ワークフローが終了します。

バックエンドの準備をする

Kurocoの登録

まずはKurocoのアカウント登録します。無料トライアルより必要項目を記入し、「登録する」をクリックします。

注意

KurocoWorkflowはサブサイトで運用します。
メインサイトとサブサイトで別々のサイトキーになるのでそれぞれ準備してください。

無料トライアルから登録するサイトキーはメインサイトのものになります。

登録したメールアドレスに登録完了のメールが届きます。メール内に記載されている管理画面URLをクリックし、ログインを行うと下記画面が表示されます。

サブサイトの追加

サイト一覧からKurocoWorkflow用のサブサイトを追加します。

備考

メインサイトのデフォルトは会員制サンプルサイト用の設定になっています。
お支払い用のクレジットカードはメインサイトで登録し、サブサイトの利用料を含めた費用がメインサイトに請求されます。

[環境設定] -> [サイト一覧]をクリックします。

[追加]をクリックします。

コピー元のサイト名をworkflow(Default)に設定し、必須項目を入力して[追加する]をクリックします。

サブサイトの登録完了のメールが届いたらログインをしてコンテンツを確認します。

注記

以降、Kuroco管理画面の説明はすべてサブサイトのものになります。

APIドメインの確認

Slack連携に必要となるAPIドメインを確認します。[環境設定] -> [アカウント設定]をクリックします。

アカウント設定画面が表示されるので、「APIドメイン」を確認します。

こちらは後ほど利用するのでコピーをとっておいてください。

エンドポイントの確認

Slack連携に必要となるエンドポイントを確認します。
[API] -> [ForSlack]をクリックします。

すでに作成されているエンドポイントのパスを確認します。

上記の場合、/rcms-api/3/event をコピーしておいてください。

一旦ここまででKurocoの登録完了です。

Slackアプリのインストール方法

Slackアプリの作成からBot User OAuth Tokenの取得、Kurocoへの設定までは共通手順です。
SlackアプリのBot User OAuth Tokenを取得してKurocoに設定するを参照して実施してください。

KurocoWorkflowでは、共通手順の「Appを作成する」で貼り付けるAppマニフェストに以下を使用します。

_metadata:
  major_version: 1
  minor_version: 1
display_information:
  name: KurocoWorkflow
features:
  bot_user:
    display_name: KurocoWorkflow
    always_online: true
oauth_config:
  scopes:
    bot:
      - app_mentions:read
      - channels:history
      - chat:write
      - emoji:read
      - im:history
      - im:write
      - mpim:history
      - reactions:read
      - team:read
      - users:read
      - groups:history
      - groups:read
      - groups:write
settings:
  event_subscriptions:
    request_url: https://sample.a.kuroco.app/rcms-api/3/event
    bot_events:
      - app_mention
      - reaction_added
      - reaction_removed
  org_deploy_enabled: true
  socket_mode_enabled: false
  token_rotation_enabled: false

注意

上記コード内の https://sample.a.kuroco.app/rcms-api/3/eventには、先ほどKurocoの管理画面でコピーした APIドメイン/エンドポイントを記載してください。

イベントの設定

共通手順のAppをWorkspaceにインストールまで完了したら、イベントを設定します。左サイドバーより[Event Subsctriptions]をクリックします。

Request URLには、先ほど同様コピーした APIドメイン/エンドポイント を入力し、[Save Changes]をクリックします。

イベントの設定が完了したら、共通手順のBot User OAuth Tokenの取得以降を実施し、Kuroco管理画面にBot User OAuth Tokenを設定してください。

注記

KurocoWorkflowはリマインドをDMで送信します。チャンネルへの投稿を行わない場合、共通手順のSlackチャンネルへアプリの追加は不要です。

以上で設定完了です。

動作確認

それではSlackにて動作を確認します。対象のSlack Workspaceに移動し、@kurocoWorkflow と自分にメンションをつけてメッセージを投稿します。

「👍」スタンプでリアクションしない場合、リマインダーが届きます。

運用

投稿の確認

Kurocoの管理画面[コンテンツ] -> [ワークフロー]より、投稿状況が確認できます。

絵文字管理

Kurocoの管理画面[コンテンツ] -> [マスタ] -> [アクション絵文字]をクリックします。

マスタ編集より、絵文字とアクションの管理ができます。

現在は下記のように設定されています。

action	アクション名	emoji	絵文字	説明
canceled	キャンセルする	x	❌	ワークフローのメッセージ内に編集で記入するとキャンセルになります。
approved	承認する	1	👍	ワークフローを承認します。メンションされた人が承認か拒否を全員すると完了します。
rejected	拒否する	-1	👎	ワークフローを拒否します。メンションされた人が承認か拒否を全員すると完了します。
asap	緊急	fire	🔥	ワークフローのメッセージ内に編集で入れると緊急（1時間毎に通知）になります。
watch	ウォッチする	eyes	👀	ワークフローが完了になると通知がきます

マスタはCSVのアップロードにより、編集可能です。

備考

管理画面マニュアル -> マスタ

関連ドキュメント

• SlackアプリのBot User OAuth Tokenを取得してKurocoに設定する
• Slack
• サイト一覧
• マスタ
• お問い合わせの受信通知をSlackで送信する