注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

Webhook の設定

このチュートリアルでは、外部システムに HTTP リクエストを送信するための Webhook を設定する方法について説明します。

前提条件

このチュートリアルでは、REST API ソースと、そのソースに関連付けられた Webhook の作成を説明します。すでにソースを作成している場合は、Webhook の作成の手順に進んでください。

インターネットからアクセスできないシステムに接続しようとしている場合は、エージェントランタイムを設定し、証明書を追加するために追加の手順を実行する必要があります。エージェントランタイムは高度な概念であり、設定や管理が複雑になることがあります。可能な限り、ダイレクト接続を使用することをお勧めします。

エージェントランタイムの使い始め方については、以下のガイドを参照してください。

エージェントランタイムを使用した Webhook をプロダクションで使用する場合は、Webhook 用に専用のエージェントをプロビジョニングすることをお勧めします。エージェントは受信した順にタスクを実行するため、バルク同期と Webhook が同じエージェントで実行されると、短い実行時間の Webhook タスクが長い実行時間のバルク同期の後ろにキューに入ることがあります。

このチュートリアルで作成するソースの権限管理を行うプロジェクトを持っていることを確認してください。プロジェクトをまだ作成していない場合は、プロジェクトのドキュメントで方法を学んでください。

チュートリアル

このチュートリアルでは、オープンインターネット上で利用可能なシステムの REST API を使用することを想定しています。

SAP、レガシー Salesforce、レガシー magritte-rest-v2 などのソースは、より複雑なタスク設定を使用しています。Webhook タスクの設定に関する詳細は、webhooks リファレンスを参照してください。

ソースの作成

まず、Data Connection に移動し、Sources タブを選択します。次に、New source と REST API を選択します。

New REST API source

ソースエディタを使用して、接続する REST API の設定詳細を入力します。REST API ソースタイプの詳細については、ソースタイプリファレンスを参照してください。

ソースは、接続を確立するために必要な最小限のシークレットと接続詳細を含むことを目的としています。このソースを使用して個々の Webhook を設定する際には、相対パス、クエリパラメーター、ヘッダー、およびボディコンテンツを含む追加のリクエスト詳細を追加する機会があります。

その他のソースタイプ

他のソースタイプの一部も Webhook をサポートしています。詳細については、特定のソースタイプのリファレンスページを確認してください。

Webhook の作成

ソースが作成されたら、Webhooks タブを選択し、New webhook を選択します。

New webhook

New webhook ウィザード の手順に従って、外部リクエストを行う Webhook を作成します。以下の例では、POST リクエストを example ドメインの /api/v1/createItem エンドポイントに送信しています。ボディは Raw JSON として構築され、この場合、2 つの文字列入力パラメーターを受け入れるように設定されています。

New webhook

設定オプション

Webhook に名前を入力し、必要に応じて説明を追加します。
このチュートリアルの前の手順で作成したソースを選択します。ソースページからウィザードに直接移動した場合、ソースが事前に選択されます。
外部リクエストで使用する入力パラメーターを追加します。
パス、クエリパラメーター、ヘッダー、およびボディ設定セクションで入力パラメーターを参照して、リクエスト設定の必要な部分を入力します。
必要に応じて、Webhook に適用する Limits を設定します。詳細については、Limits リファレンスを参照してください。
Create をクリックして、Webhook の作成を完了します。

cURL コマンドからの直接インポート

別の方法として、cURL コマンドを直接インポートしてリクエストコールを作成することもできます。これを行うには、Import from cURL オプションを選択し、TextArea に cURL コマンドを入力します。cURL がサポートされているオプションを使用し、ソース内のドメインに関連している場合、Import cURL を選択すると新しいコールが作成されます。

Webhook のテスト

保存後、設定が正しいかどうかを確認するためにテストリクエストを実行できます。これは、Test Connection サイドパネルを使用していつでも行うことができます。

テストリクエストが行われた後、レスポンスを使用して出力パラメーターを解析できます。出力パラメーターの詳細については、webhooks リファレンスページを参照してください。

次のステップ

このチュートリアルでは、ソースの作成と、そのソースに関連付けられた Webhook の作成方法を学びました。次に推奨するリソースは以下の通りです。

アクションタイプチュートリアルを表示して、エンドユーザーアプリケーションで使用するための Webhook を設定する方法を学びます。
Webhooks リファレンスを読んで、Webhooks を設定するための利用可能なオプションの詳細を確認してください。