説明
主にWebアプリケーション内で、特定のイベントが発生したらJENKAに対して通知する機能です。
Webhookの利用については、Webアプリケーション側の設定などを行う必要があります。
Webhookの設定方法は、Webアプリケーション側の設定手順を参照してください。
検知方式
項目ごとの説明
コネクタ名
対象コネクタの名称を記載
Webhook URL
URLをコピーして送信側のWebアプリケーションで利用
※URLはコネクタ毎に準備
HTTPメソッド
通信のメソッドを指定
※指定可能メソッド
・GET
・POST
※Webアプリケーションにより異なる
認証方式
該当する認証方式を指定
※指定可能認証方式
・Basic認証
・Key-Value認証
・None
Webhookを受信するボタン
設定した内容で受信に問題ないかテストが可能
※受信されるパラメータを後続コネクタに渡すためには必ず一度テスト受信実行が必要
※受信されるパラメータの構造が変わる場合は、テスト受信を再実行するか新しいWebhook(受信)コネクタの利用が必要
受信パラメータ
受信されたパラメータキーのリストが表示
※変数として利用可能
※Header情報も含めて表示される
※パラメータの上下関係は「.」で表示される
※該当パラメータに複数件の情報が取得される場合は、カンマ区切りで出力される
設定手順
1. ワークフローに「Webhook(受信)」コネクタを追加し、詳細設定を行います。
※詳細設定についてはWebアプリケーションの設定例などを参照ください。
2. 「Webhookを受信する」ボタンをクリックします。
3. 以下のような状態になります。この間に、連携先のWebアプリケーションでJENKAのWebhookを対象にデータを送信してください。
4. JENKAのWebhookが受信できると、キーの一覧が表示されて完了です。
5. 後続のワークフロー作成後に公開をして、Webhookが利用できるようになります。
注意事項(仕様など)
- サービスによりWebhookの利用について制限事項があるため、利用先の制限事項を確認してください。
変数の説明
変数名
|
データタイプ |
説明
|
| 実行日時 |
TEXT |
コネクタが実行された日時 |
| 実行ステータス |
BOOL |
コネクタの実行結果 |
| 受信されたパラメータキーのリスト |
TEXT |
受信されたパラメータの値 |