Webhook(受信)コネクタ

Webhook(受信)コネクタ

概要

主にWebアプリケーション内で、特定のイベントが発生したらJENKAに対して通知する機能です。
Webhookの利用については、Webアプリケーション側の設定などを行う必要があります。Webhookの設定方法は、Webアプリケーション側の設定手順を参照してください。

設定手順

  • Webhookの送信元に合わせたHTTPメソッドや認証情報などを設定します。設定例も 
    項目名
    必須
    		内容備考
    コネクタ名
    〇
    		対象のコネクタ名を記載ex.X時間ごと○○等わかりやすいもの　
    Webhook URL
    〇
    		URLをコピーして送信側のWebアプリケーションで利用
    URLがコネクタ毎に準備
    HTTPメソッド
    〇
    		POSTかGETを選択Webアプリケーションにより異なる
    WEBHOOKを受信する

    		トリガーの対象となるフォルダ許可したフォルダから選択
    受信に成功すると、受信したデータのパラメータが表示されます。

    		設定が完了したら、一度Webhookの受信実施。 
    受信が成功すると、パラメータ表示欄に受信したキーの一覧が表示。
    受信したデータをもとに、キーを変数として、データの内容を値として保持して、後続のワークフローで偏すとして利用可能。


    Webアプリケーションの設定例などを参照ください。

  • JENKA：受信ボタンをクリックして、システム側でテストの動作
         


  •   以下のような状態になります。この間に、連携先のWebアプリケーションでWebhookを対象データを送信してください。
     

  • JENKAWebhookが受信できるとキーの一覧が表示されて完了です。

  • 後続のワークフロー作成後に公開をして、Webhookが利用できるようになります。


    • 設定例


    接続するWebサービスにより接続方法が異なります。いくつかの設定例を掲載しますのでご参照ください。

    Chatworkの設定例

    ＜JENKA側パラメータ設定＞
    メソッド：POST
    認証：NONE


    ＜Chatwork側の設定＞
    1.右上の選択メニューからサービス連携を選択


    2.Webhookの新規作成をクリック

    3.以下の通り設定し保存。
    　WebhookURL：JENKA側のWebhookコネクタで発行されたURLを貼り付け
    　イベント：ルームイベントを選択、Webhookを動かす為のアクションを選択
        ルームID：Webhookを利用するルームIDを入力
             ※ルームIDは、送信したい先のURLに記載のある数字の部分です。こちらを記載します。
       

    webhookに戻り、「webhook」を受信するにした状態で、ChatworkでWebhookを設定したマイチャットやグループでテスト送信を行ってください。

    kintoneの設定例

    ＜JENKA側パラメータ設定＞
    メソッド：POST
    認証：NONE
    ＜Kintone側設定＞
    1.利用したアプリ内の歯車の設定ボタンより「アプリの設定」画面に遷移

    2.設定タブを開き、「Webhook」を選択
    3. Webhookの一覧画面に遷移するので、「+追加する」ボタンから「Webhookの作成」に遷移
    4.下図、赤枠の欄にJENKAでコピーとURLを貼り付けする。また通知する際の条件を指定

    Salesforceの設定例

    ＜JENKA側パラメータ設定＞
    メソッド：POST
    認証：NONE

    ＜Salesforceの設定箇所＞
    1.設定箇所は、検索窓で「ワークフロールール」を検索



    2.「ワークフロールール」に遷移したら、以下の赤枠部分をクリック


    3.以下の「編集」をクリックし、Webhookのエンドポイントを設定。

    BowNowの設定例

    ＜JENKA側パラメータ設定＞
    メソッド：POST
    認証：NONE

    ＜Bownow側の設定＞
    の説明に従い、Bownow側でWebhookの設定

    Backlogの設定例

    ＜JENKA側パラメータ設定＞
    メソッド：POST
    認証：NONE

    ＜Backlog側の設定＞
    1.プロジェクトの設定画面にクリックして、インテグレーションメニューの中のWebhookの編集をクリック

    2.Webhook を追加するをクリック

    3.WebhookURLにJENKA側のWebhookコネクタで発行されたURLを貼り付け。
    通知するイベントを選択して、「Webhookを追加する」をクリックして設定は完了。

    Boxの設定例



    注意事項

    サービスによりWebhookの利用について制限事項があるため、利用先の制限事項を確認してください。



      • Related Articles

      • Webhook(発信)コネクタ

        概要 外部のWebアプリケーションへJENKAを通して着信した情報などを発信します。 設定方法 以下を設定して保存する。 項目名 必須 内容 備考 コネクタ名 〇 対象のコネクタ名を記載 ex.X時間ごと○○等わかりやすいもの　 Webhook URL 〇 Webアプリケーションから発行されているURLを記載する HTTPメソッド 〇 POSTかGETを選択 送信先のWebアプリケーションにより異なるため、Webアプリケーションの仕様を確認してください。 認証方式 〇 ...

      • Slack メッセージの受信検知(トリガー)

        説明 指定したチャンネルに送信されたメッセージを検知する 検知方式 SlackのWebhookを利用 項目ごとの説明 コネクタ名 対象コネクタの名称を記載 認証 対象コネクタの認証を指定 投稿先のチャンネル 検知対象のチャンネルを指定 ※チャンネルはJENKAアプリが追加されているチャンネルのみ表示され、指定できます。 　チャンネルにJENKAアプリを追加する方法については下記の「チャンネルにJENKAアプリを追加する手順」をご覧ください。 トリガータイプ 検知するメッセージタイプを指定 ...

      • 待機コネクタ

        説明 指定した時間までワークフローの実行を止め、次のコネクタの動作を待機します。 項目ごとの説明 コネクタ名 対象コネクタの名称を記載 待機時間 次のコネクタの実行まで待機する時間を指定 ※最大600秒を設定できます。 注意事項（仕様など） 1ワークフローあたりに待機可能な上限は3600秒です。 長時間の待機や複数設置する場合の注意 ...

      • 合流コネクタ

        概要 2つのフローが完了し、合流するまで次のフローには流れなくさせます。 仕様 1つのコネクタより分かれている必要があります。下記のワークフローの場合、GoogleDriveへのファイルのアップロードと、Googleスプレッドシートへの情報の追加、両方の完了後にChatworkで通知します。 以下の場合は、合流するワークフローの起点が一致しないため、Chatworkの通知は動作しません。

      • 定期実行コネクタ

        概要 指定間隔で定期的にワークフローを実行します。年、月、日、週、曜日、時間などで指定できます。 設定方法 分、時間、日ごと および 年ごと 以下の項目を設定して、[保存]をしてください。 項目名 内容 備考 コネクタ名 対象のコネクタ名を記載 ex.X時間ごと○○等わかりやすいもの　 実行間隔 X(分/時間/日) 条件にしたい数字と頻度を選択 開始日 対象のワークフローを開始したい日付 開始時刻 対象のワークフローを開始したい時刻 週間ごと 以下の項目を設定して、[保存]をしてください。 ...