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

      • Zoomコネクタ

        トリガーコネクタ用の認証方法 事前にワークフロー上で、コネクタ追加 > 「トリガー」タブ > Zoom を選択してコネクタを設置し、Zoomトリガーコネクタの設定を開いておいてください。 設定画面の中で空欄の Secret Token の値と、Webhook URL 以下の項目については以降の手順で使用します。 Zoom側でのアプリ(App)の作成方法 https://marketplace.zoom.us/ にログインします 画面右上のメニューより、Develop > Build App ...
      • Boxコネクタ

        ファイルIDとフォルダIDについて Boxで連携を行うためには、ファイルIDとフォルダIDについての理解が必要になります。 ファイルID ファイルIDは、ファイルのユニークなIDです。ファイルを開いた際に表示されるURLの一部が、ファイルIDとなります。 このURLは、ファイルを開いた際のURLに記載されています。 フォルダID フォルダIDは、フォルダのユニークなIDです。フォルダを開いた際に表示されるURLの一部が、フォルダIDとなります。 アプリ設定 ...
      • kintoneコネクタ

        ご注意 ・JENKA と kintone の連携は、kintone のプランが「ライト」の場合は、API連携(サービス認証・Webhook を含む) がご利用になれません。 ・サブドメインの異なる環境で作成したゲストスペース上のアプリは操作できません。 ・テーブルの操作については、注意が何点かございます。  -検索の場合は最終行の情報のみ変数のデータとして取得可能です  -レコードの追加の際、テーブルの1行のみ追加可能です。  -レコードの更新の際は、テーブルの行の追加が行えません。 ...
      • Webhook(発信)コネクタ

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

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