Webhook トリガーの設定

設定された Webhook トリガー

入力項目

入力項目		説明
Event name		Webhook トリガーがリッスンしているイベントの名前。この名前は、生成される固有の Webhook アドレスの構成要素になります。この URL は入力項目の下に表示され、コピーできます。 レシピが複数のソースから Webhook イベントを受信しないようにするには、Webhook レシピ全体で一意のイベント名を指定する必要があります。 具体的には、生成される Webhook アドレスは、1つの Workato アカウントのすべての Webhook トリガーで一意でなければなりません。
Payload configuration	Webhook type	受信する Webhook に対応するタイプを選択します。以下のいずれかを選択できます。 GET リクエスト JSON ペイロードでの PUT/POST XML ペイロードでの PUT/POST フォームエンコードされたペイロードでの PUT/POST Raw バイナリデータでの PUT/POST ユニコードテキストデータでの PUT/POST
	Payload schema	Webhook イベントから取得する項目を指定します。Webhook ウィザードを使用する場合は、サンプルの Webhook イベントがテンプレートとして使用され、この項目は自動的に生成されます。 ウィザードを使用しない場合は、2つの方法で入力項目を設定できます。サンプルのペイロードを使用してすべての項目を一度に取得する方法が簡単ですが、項目を一つ一つ追加することもできます。 この項目の定義が必要になるのは、以下の Webhook タイプを選択したときだけです。 GET リクエスト JSON ペイロードでの PUT/POST XML ペイロードでの PUT/POST フォームエンコードされたペイロードでの PUT/POST
	Headers	Webhook イベントから取得するヘッダーを指定します。 Webhook イベントから取得するヘッダーを指定します。Webhook ウィザードを使用する場合は、サンプルの Webhook イベントがテンプレートとして使用され、この項目は自動的に生成されます。 ウィザードを使用しない場合は、2つの方法で入力項目を設定できます。サンプルの JSON を使用してすべての項目を一度に取得する方法が簡単ですが、項目を一つ一つ追加することもできます。

出力項目

入力項目	説明
Headers	この出力オブジェクトには、このレシピを呼び出す Webhook イベントから取得できるすべてのヘッダーのデータピルが含まれます。不足しているヘッダーを追加するには、[Headers] 入力項目に項目を追加します。
Payload	この出力オブジェクトには、このレシピを呼び出す Webhook イベントから取得できるデータに対応するデータピルが含まれます。これらの項目を追加/編集するには、[Payload schema] 入力項目を更新します。

Webhook レスポンス

Workato Webhook はデフォルトで、200 レスポンスコードと JSON ペイロード ({"status":"ok"}) が含まれるイベントに応答します。以下にサンプルを示します。

$ curl 'https://www.workato.com/webhooks/rest/b48a7c64-a7dd-4185-936b-ada1ca84e9fd/foobar' -i
 
HTTP/1.1 200 OK
Date: Wed, 28 Jul 2021 10:03:18 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Server: nginx
Vary: Origin
X-Request-Id: 0b6d7f2ffbfab278c685080aed91d690
X-Correlation-Id: 0b6d7f2ffbfab278c685080aed91d690
Strict-Transport-Security: max-age=31536000; includeSubDomains

{"status":"ok"}

カスタムレスポンス

Webhook クライアントは、場合によっては、HTTP レスポンスの1つ以上の部分で個別のレスポンス構造を必要とします。これに対応するため、Webhook コネクターはデフォルトのレスポンスを変更するためのクエリーパラメータを用意しています。

クエリーパラメータ	指定可能な値	説明
workato_response_code	2XX コードのみ。デフォルトは 200 です。	個別のレスポンスステータスコードを返します。例: 201、204
workato_empty_response	true/false (デフォルト)	{"status":"ok"} ではなく、空のレスポンス本体を返します。

::: 204 No Content レスポンスコード
204 レスポンスコードを使用すると、レスポンス本体は空になります。これは workato_empty_response=false よりも優先されます。 :::

以下の例では、workato_response_code=201 を使用して、HTTP レスポンスコードとして201 Created を返します。

$ curl 'https://www.workato.com/webhooks/rest/b48a7c64-a7dd-4185-936b-ada1ca84e9fd/custom-code?workato_response_code=201' -i

HTTP/1.1 201 Created
Date: Wed, 28 Jul 2021 10:05:03 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 15
Connection: keep-alive
Server: nginx
Vary: Origin
X-Request-Id: b23380f48d02c38fa761e8afa4b94862
X-Correlation-Id: b23380f48d02c38fa761e8afa4b94862
Strict-Transport-Security: max-age=31536000; includeSubDomains

{"status":"ok"}