Webhook

Webhook

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Webhookにより、Circuitとサードパーティアプリケーション間の連携が促進されます。Webhookでは、ビジネス要件に応じて事前定義された処理が実行されたときに、API呼び出しを行い、通知をトリガーできます。
 
前提条件

関連する項目の詳細を指定して、ブリッジで実行するWebhookを作成します。こちらをクリックして、QntrlでWebhookを作成する方法を確認してください。

 

使用例：従業員のオンボーディングプロセスでは、Webhook状態を電子文書の検証に使用できます。これは、検証サービスプロバイダーに接続し、検証結果や更新情報をWebhookエンドポイントに送信するよう設定することで行います。受信した応答を分析して、次の手順を設定できます。

ビルダー表示

ビルダー表示で、WebhookをCircuitに連携するには、次の手順を実行します。
  1. 左側のペインから［Webhook］状態をCircuitにドラッグ＆ドロップするか、Circuit内の対象のWebhook状態をクリックします。
  2. ［設定］で、共通の状態項目属性を更新します。
  3. ［種類］項目では、Webhookが初期設定で選択されています。Circuitに追加する［Webhook名］をドロップダウンリストから選択します。
  4. ［同期］項目で、Webhookを同期的に実行するか非同期的に実行するかを選択します。
    • True：Circuitは、次の状態に進む前にWebhookの応答を待機します。
    • False：Webhookは非同期で実行され、［タイムアウト］項目が表示されます。
  5. ［タイムアウト］項目で、CircuitがWebhookの応答を待機する時間を指定します。
    • 設定したタイムアウト期間内に応答がない場合、実行は失敗としてマークされます。
    • 許可されるタイムアウト範囲は、30秒から30日までです。
  6. 状態の［エラー処理］オプションを指定します。エラー処理の詳細はこちら。
    
  1. 右ペインの［入力／出力］で、必要に応じて次の詳細を入力できます。
    • ［入力パス］、［出力パス］、［結果パス］、［結果セレクター］を入力します。I/Oパスの詳細はこちら。
    • リクエストデータの送信に必要なデータバイトは、［本文］に指定します。
    • Webhookに設定されているカスタムパラメーターとカスタムヘッダーに加えて、このWebhook状態とこのCircuitに固有の動的なパラメーターとヘッダーを［パラメーターを追加］と［ヘッダーを追加］を使用して定義します。
      • ［パラメーターを追加］ - パラメーター名とパラメーター値を指定します。Webhookをトリガーする際、これらのパラメーターがサードパーティアプリケーションに送信されます。
      • ［ヘッダーを追加］ - ヘッダー名とヘッダー値を指定します。Webhookをトリガーする際、設定されたヘッダーがAPIリクエストに追加されます。    

  1. ［保存して実行］をクリックします。
  2. テスト実行用のテストデータを［入力JSON］として指定し、［次へ］をクリックします。
  3. ［テスト実行名］として、この実行の一意の名前を指定します。［実行］をクリックします。
  4. アプリケーションで、Webhook通知を通じてQntrl Circuitから受信したデータを確認します。
  5. 失敗やデータの不一致がある場合は、Qntrl CircuitでWebhook設定を変更します。
  6. Circuitからアプリケーションに必要なデータを取得できるまで、このテストを繰り返します。

コード表示

コード表示でWebhookを設定するためのJSONを以下に示します。
 
{
'Verify Employee Documents': {
'type': 'Webhook',
'next': 'Action - Approve or Reject',
'sync': false,
'webhook_id': 'employee_document_verification_1',
'timeout': 300,
'parameters': {
'pan_number': 'pan.number'
},
}






次へ：Circuit状態