テーマ
direct連携(トークへの通知)
インシデントの節目(発生・解決・クローズ・再オープン)と報告書の登録を、ビジネスチャット「direct」のトークへ通知します。現場の担当者がSISAのアプリを開いていなくても、普段使っているトークで状況の変化に気づけます。
通知は次の形で届きます。最後の行のURLがリンクになっていて、押すとSISAの該当画面が開きます。
SISAインシデントがオープンしました。
監視ユニット: 苅藻川水位計測
担当者: 示唆太郎
件名: 水位上昇アラート
https://console.sisa.jp/orgs/…/incidents/… ← リンクご利用の前提
| 項目 | 条件 |
|---|---|
| SISAのプラン | Businessプラン以上 |
| 操作できる人 | 組織のオーナー・管理者 |
| 設定する場所 | Webコンソールの組織設定(/orgs/{orgId}/settings)内「外部サービス連携」。モバイルアプリには設定画面はありません |
| direct側 | direct のアプリケーションを作成できる権限(組織の管理者)。REST APIのご利用にはdirectの契約が必要です。詳細はdirectの提供元(株式会社L is B)にご確認ください |
| 通知先 | 組織につき1つのトーク(グループトークまたはペアトーク) |
通知は「承認したアカウント」の名前で投稿されます
direct の仕様上、SISA は通知を direct のアカウントとして投稿します(SISA専用のBotではありません)。通知の投稿者は、手順3で承認画面にログインしたアカウントの名前とプロフィール画像になります。
個人名ではなく「SISA」の名前で通知したい場合は、自社の direct 組織に通知用のアカウント (表示名「SISA」など)を1つ作り、そのアカウントでログインして承認してください。通知用のアカウントは direct の1アカウントとして数えられます(費用は direct の契約によります)。
全体の流れ
direct 側でアプリケーションを1つ作り、その Client ID / Client Secret をSISAのコンソールに入力して、direct の承認画面で接続します。
- direct のアプリケーションページでアプリケーションを作る → Client ID / Client Secret
- SISAのコンソールに2つの値を入力して「direct と接続」→ direct の承認画面で承認する
- 通知先のトークに、承認したアカウントを参加させる
- SISAのコンソールで投稿先のトークを選び、「設定を保存」→「テスト送信」で確認する
所要時間は10〜20分ほどです。direct 側の画面の名称・配置は、direct の更新によって変わることがあります。
手順1: アプリケーションを作成する(direct)
direct にログインし、アプリケーションページ(https://direct4b.com/applications)で新しいアプリケーションを登録します。
| 項目 | 入れるもの |
|---|---|
| アプリケーション名 | 任意(例: SISA) |
| サイトURL | https://console.sisa.jp/ |
| リダイレクトURL | https://console.sisa.jp/integrations/direct/callback |
登録すると Client ID と Client Secret が表示されます。この2つを控えてください。
リダイレクトURLは1つだけ・完全一致
direct のアプリケーションに登録できるリダイレクトURLは1つだけです。上のURLをそのまま (末尾のスラッシュなし・https)登録してください。1文字でも違うと承認に失敗します。
Client Secretを再発行すると連携が止まります
Client Secret を再発行すると、発行済みの接続がすべて無効になります。再発行した場合は、SISAのコンソールで新しい値を入力して再接続してください(それまで通知は送られません)。
手順2: SISAのコンソールで接続する
組織設定(/orgs/{orgId}/settings)の「外部サービス連携」を開き、direct の欄に次の2つを入力して「direct と接続」 を押します。
| 入力欄 | 入れるもの |
|---|---|
| Client ID | 手順1で控えたClient ID |
| Client Secret | 手順1で控えたClient Secret |
手順3: direct の承認画面で承認する
direct の承認画面(「アプリケーションの利用」)が開きます。通知を投稿するアカウント (個人のアカウント、または通知用のアカウント)でログインし、「承認する」 を押してください。
- 承認すると自動的にSISAのコンソールに戻り、「direct と接続しました」と表示されます
- ⚠️ 承認画面を開いてから1分以内に承認してください。時間が経つと接続に失敗します。その場合は手順2からやり直します(Client Secret を入れ直します)
- SISAが求める権限は、本人の情報の参照・組織とトークの一覧の参照・メッセージの投稿だけです
手順4: トークに参加させ、投稿先を選ぶ
- direct で、通知を受け取りたいトーク(グループトーク)に、手順3で承認したアカウントを参加させます。専用のトークを新しく作る場合は、先に通知を受け取るメンバーを招待しておきます
- SISAのコンソールに戻ると、投稿先のトークの一覧が自動で読み込まれます。1で参加させたトークが一覧に無い場合は 「再読み込み」 を押します
- 投稿先のトークを選び、必要なら「通知する出来事」「通知の言語」を変えて 「設定を保存」 を押します
| 項目 | 説明 |
|---|---|
| 投稿者 | 手順3で承認したアカウントの表示名。通知はこの名前で投稿されます |
| 投稿先のトーク | 承認したアカウントが参加しているトークだけが表示されます。グループトークは「(グループ・人数)」、ペアトークは相手の名前で表示されます |
| 通知する出来事 | 既定では5つすべてが有効です。不要なものはチェックを外します |
| 通知の言語 | 日本語または英語。トークは組織のものなので、利用者ごとの言語設定ではなくここでの指定が使われます |
保存できたら 「テスト送信」 を押してください。トークに「SISA からのテスト送信です。この通知が届いていれば direct 連携の設定は完了です。」が届けば設定完了です。
通知される出来事
| 出来事 | いつ届くか | リンク先 |
|---|---|---|
| インシデントの発生 | アラートからインシデントが起票されたとき・手動で起票したとき | インシデントの対応画面 |
| 解決 | 対応が完了して「解決」になったとき | 該当する報告書(まだ無い場合は対応画面) |
| クローズ | インシデントがクローズされたとき | 該当する報告書(まだ無い場合は対応画面) |
| 再オープン | 解決したインシデントが対応中に戻されたとき | インシデントの対応画面 |
| 報告書の登録 | 報告書が登録されたとき | 報告書の詳細画面 |
通知はトークの参加者全員に届きます。チャットのメッセージ・音声メモなど、対応中のやりとりは通知されません (トークが流れてしまうため、節目だけをお知らせする設計です)。
通知は出来事のあとすぐに送られますが、状況により20秒ほど遅れることがあります。
設定を変更する・止める
- 投稿先・出来事・言語を変える: 接続済みの画面でそのまま変更し、「設定を保存」 を押します
- 投稿するアカウントを変える・Client Secret を再発行した: 「再接続」 から Client ID / Client Secret を入力し、承認画面で改めてログインして承認します。投稿先などの設定はそのまま引き継がれます
- 一時的に止めたい: 「通知する出来事」のチェックをすべて外して保存します
- 連携をやめる: 「切断」 を押します。SISAが持っていた接続の情報は削除され、direct 側の許可も取り消されます (投稿先や出来事の設定は残るので、再接続すれば元の設定のまま再開できます)
direct 側でアプリケーションの連携を取り消した場合や Client Secret を再発行した場合は連携が停止し、設定画面に「direct の認可が無効になっています」と表示されます。あわせて組織のオーナー・管理者にメールでお知らせします。「再接続」から接続し直してください。
うまくいかないとき
| 表示・症状 | 確認すること |
|---|---|
| 「direct との接続に失敗しました。Client ID と Client Secret を確認して、もう一度お試しください(承認画面で 1 分以上経つと失敗します)。」 | Client ID / Client Secret の貼り間違い・余分な空白、アプリケーションのリダイレクトURLが手順1のとおりか、承認画面で1分以上経っていないかをご確認ください。Client Secret を再発行した場合は新しい値が必要です |
| 承認画面で「アプリケーションの利用」が表示されない・エラーになる | ログインしているアカウントが、アプリケーションを作成した direct 組織のアカウントかをご確認ください(別の組織のアカウントでは承認できません) |
| 「参加しているトークがありません。通知先のトークに投稿者のアカウントを招待してください。」 | 承認したアカウントを通知先のトークに参加させてから「再読み込み」を押してください |
| 「direct への送信に失敗しました。投稿者のアカウントがそのトークに参加しているか確認してください。」 | 承認したアカウントがそのトークから外されていないか、トークが終了していないかをご確認ください |
| テスト送信は届くが、実際の通知が来ない | 「通知する出来事」のチェック、通知先の組織(複数の組織をお使いの場合)、組織のプランをご確認ください |
| 「直近の送信に失敗しています」と表示される | 承認したアカウントがトークから外されていないか、トークが削除されていないかをご確認ください |
| 「direct の認可が無効になっています。…」 | direct 側で連携が取り消されたか、Client Secret が再発行されています。「再接続」から接続し直してください |
| 「外部サービス連携は Business プラン以上でご利用いただけます。」 | 組織のプランをご確認ください |
| 「外部サービス連携」のセクションが表示されない | オーナー・管理者以外のメンバーには表示されません |
通知される情報について
通知には、インシデントの件名・監視ユニット名・担当者のお名前と、SISAの画面へのリンクが含まれます。これらはお客様自身の direct 組織の、お客様が指定したトークへ、お客様が承認したアカウントの名前で送られます。
他の連携
LINE WORKS をお使いの場合はLINE WORKS連携、報告書のWordファイルをBoxのフォルダへ自動保存するにはBox連携をご利用いただけます。複数の連携を同時に使うこともできます。