Channels
Overview
ChannelsページではQueryPieから送信する通知を受信するチャンネルを登録および管理します。現在QueryPieで提供するチャンネルタイプはSlack、Agit、HTTP、Emailの4つであり、チャンネル登録事前に連携のための作業が必要です。
登録されたチャンネル照会
Administrator > General > Company Management > Channelsページで現在登録されたチャンネルリストを照会できます。チャンネル名で検索が可能で、Channel Typeでフィルタリングできます。
Administrator > General > Company Management > Channels
リスト内項目をクリックすると詳細情報を照会および変更できます。
Administrator > General > Company Management > Channels > List Details
チャンネル登録
Channelsページ右上のCreate Channel
ボタンをクリックするとチャンネル作成モーダルが表示されます。
Administrator > General > Company Management > Channels > Create Channel
- Title : チャンネル名
- Channel Type : 通知を受信するチャンネルタイプを選択します。選択肢により下部追加入力項目が異なります。
- Slack : Slackチャンネルで通知送信
- Agit : アジットで通知送信
- HTTP : Zapier、Okta WorkflowsなどHTTP APIに直接リクエストする方式
- Email : メールで通知送信
Channel TypeをSlack
で選択した場合
チャンネル作成のための入力内容は以下の通りです。
Slack Appの詳細設定方法はドキュメント下部のSlack連携のためのSlack App設定方法項目を参照してください。
- Message Sending Method : メッセージ送信方式
- API : Slack APIを活用したメッセージ送信
- APIを選択した場合、New Request Alertで承認者(assignee)メンションが可能です。(10.2.2バージョン以降)
- Bot User OAuth Token : メッセージを送信するSlack AppのBot User OAuth Token
- Channel ID : メッセージを送信するSlack Appが招待されているSlack Channel ID
- Webhook : ウェブフック方式でメッセージ送信
- Request URL(必須) : リクエストを送信するURL
- Slack AppでWebhook設定後、Webhook URL情報をコピーして貼り付けする必要があります
- Request URL(必須) : リクエストを送信するURL
- API : Slack APIを活用したメッセージ送信
Channel TypeをAgit
で選択した場合
チャンネル作成のための入力内容は以下の通りです。
- Request URL (必須) : リクエストを送信するURL
- Agit Channel : アジットチャンネルに表示する名前入力
Channel TypeをHTTP
で選択した場合
チャンネル作成のための入力内容は以下の通りです。
- Request URL (必須) : リクエストを送信するURL
- Request Header (JSON) : 必要時呼び出しのためのリクエストヘッダーを入力(JSON形式)
- Body Template : リクエストボディテンプレート
- デフォルト値:
{{message}}
- Alertで定義されるメッセージの前後に共通で追加したい内容を記入
- デフォルト値:
Channel TypeをEmail
で選択した場合
注意
QueryPieにEmail送信のためのSMTPサーバーを登録した場合のみEmailタイプのチャンネルを作成できます。
Admin > General > System > Integrationメニューに進入後、Emailタイルをクリックして関連設定を確認してください。
チャンネル作成時入力内容は以下の通りです。
- Email Recipients (必須) : メール受信者
- QueryPieに登録されたユーザーを選択でき、登録されたメールアドレスでメールが送信されます
- Body Template : リクエストボディテンプレート
- デフォルト値:
{{message}}
- Alertで定義されるメッセージの前後に共通で追加したい内容を記入
- デフォルト値:
チャンネル削除
Channelsページ内チャンネルリストで削除したいチャンネルをチェックボックスで選択するとDelete
ボタンが表示されます。ボタンをクリックすると削除確認モーダルが出力されます。OK
ボタンをクリックすると削除が完了します。
Administrator > General > Company Management > Channels > Delete確認モーダル
Slack連携のためのSlack App設定方法
1. App作成
Slack API > Apps > Create an App
- https://api.slack.com/apps に移動します。
Create an App
ボタンをクリックします。- 上画面で通知を送信するApp NameとSlack Workspaceを選択します。
Create App
をクリックします。
2-1. Webhookタイプで連携
Slack API > Apps > Settings > Incoming Webhooks
- 該当アプリページ内で
Incoming Webhooks
メニューに移動します。 - Activate Incoming Webhooksオプションを有効化します。
- 下部の
Add New Webhook to Workspace
をクリックします。
Slack内Webhook追加画面
- Workspace内に警報を送信するチャンネルを選択した後
許可
ボタンをクリックします。 - 生成されたWebhook URL情報をコピーした後、QueryPieチャンネル作成モーダルに貼り付けます。
2-2. APIタイプで連携
- 生成したAppをクリックしてアプリのSettingsページに進入した後、
App Manifest
メニューに移動します。 - scopes領域に
chat:write
,users:read
,users:read.email
を追加した後保存します。 - 上部の黄色い通知バーを通じて
Reinstall your app
でアプリを再起動します。(必須) Reinstall to {Workspace_name}
ボタンをクリックして通知を送信するSlackチャンネルを選択した後許可
ボタンをクリックします。- Scopeを変更した後適用するには、この段階を再度実行する必要があります。
- 該当Slackチャンネルに移動して生成したアプリを追加します。(既にアプリを追加した状態であればこの段階はスキップできます)
- チャンネル名をクリックしてChannel Detailモーダルを開き、モーダル下部でChannel IDをコピーします。コピーしたChannel IDをQueryPieチャンネル作成モーダルに貼り付けます。
- OAuth & PermissionsページでBot User OAuth Tokenをコピーし、QueryPieチャンネル作成モーダルに貼り付けます。