WEBHOOKの活用について
回答済み
お世話になっております。
弊社概念テストにおいて、WEBHOOKがどれほど活用性があるかに未着目だったので、その利便性と活用法について教えてください。
webhookはアプリケーションの更新情報を他のアプリケーションへ提供する仕組みで、イベント発生時、指定したURLにPOSTリクエストする。APIと違いリクエストしなくてもレスポンスしてくれるが、あらかじめ設定した条件を満たした場合に限る、とありました。
質問【20210730_1】
①AlertHub でルール不一致が発生しルールが破棄された場合に、webhookによって指定したURL（例えば Enterprise）に何らかの通知を出すことは可能ですか？
②AlertHub のマニュアルからは、webhook の利用は
・受信スロットにて読み込み
・アクションにてwebhookを利用しAPI呼び出し
・ルールにて条件判定のデータとして読み込み
などがあるようですが、
メールの時とどのように違いがでてくるのでしょうか？
③現在メール本文にて正規表現とマッチしたら、アクションでPigeonの架電を動かしていますが、同じスコープの中に「正規表現とマッチしなかったら」のルールを追加し、その時はwebhook で対象url にリクエストを送るなど、同時に「正」と「否」の処理を指定したりもできるのでしょうか？
④その際、webhook のアクション定義はどのようにすればよいか事例をご教示ください。
webhook URL:Enterprise のURL で良いか？
リクエスト本文／HTTPヘッダの指定例など
-
正式なコメント
①
受信したメッセージがルールに不一致だった場合、AlertHub から能動的に処理を実行することはできませんので、
Webhook での通知なども行えないものとなります。②
AlertHub において Webhook を利用するポイントは、
メッセージの受信と、アクションの2点になるためそれぞれで説明させていただきます。Webhook によるメッセージの受信については、メールでの受信と実現出来ることについての差異は実質ありません。
設定においては差があり、メールではルールにおいて正規表現などで内容の解析を行う必要がありますが、
メッセージを Webhook で JSON 形式で送信した場合は、送信された情報の項目値は AlertHub で自動的に解析されますので、
ルールでの指定が簡便になることが利点としてあげられます。下記のハンズオンガイドは Webhook でメッセージを受信した場合での設定方法を記載していますので、
参考にしていただければと思います。
https://kompira.zendesk.com/hc/ja/articles/4403090530201アクションにおける Webhook は、AlertHub からの連携先がどういった形式を受け付けられるか、
という点や要件という点で使い分けを行うべきではありますが、
連携先が Webhook を受信した際の異常などが AlertHub の画面上などで確認をしやすいなどといった利点はあるかと思います。③
1つのメッセージに対して、「正規表現とマッチしたら」と「正規表現とマッチしなかったら」の2通りのルールを用意し、
それぞれで異なるアクションを実行することは可能です。
その場合、具体的な要件次第とはなりますが、それぞれのルールに一致するものは状態や対象が異なるメッセージと考えられますので、
スコープは分けて用意すべきかと思います。④
Webhook のアクションで KompiraEnterprise を呼び出す場合については、以下を参考にしていただければと思います。
https://www.kompira.jp/column/start_jobflow_with_rest_api/
URL については「API のエンドポイント」をご確認ください。
また Webhook アクションの HTTP ヘッダについては、「API のユーザ認証」をご確認ください。Webhook を受信するジョブフローについては以下も参考になるかと思いますのでご確認ください。
https://www.kompira.jp/column/post_to_kompira_from_redmine/コメントアクション
サインインしてコメントを残してください。
コメント
1件のコメント