Webhookをキャッチする(トリガー)

このピースでできること

  • 任意のHTTPメソッド(GET/POST/PUT/DELETEなど)で届くリクエストを受信し、フローを起動します。
  • ライブURL、テストURL、同期URLの3種を使い分けできます。

ピースの設定項目

1. 認証(必須)

  • なし(none)/ ベーシック認証(basic)/ ヘッダー認証(header)/ HMAC Signature(hmac)から選択します。

2. 認証フィールド(任意・動的)

  • 選択した認証タイプに応じて必要なフィールドを設定します。
  • 認証方式を選ぶと、対応する入力欄が表示されます。
  • ベーシック認証:Username()、Password()。
  • ヘッダー認証:Header Name()、Header Value()。
  • HMAC Signature:Signature Header Name(、必須)、Secret(、必須)、Algorithm(、必須・既定sha256)、Signature Encoding(、必須・既定hex)、Signature Prefix(、任意)。
  • AlgorithmはSHA-256/SHA-1/SHA-512、Signature EncodingはHexadecimal/Base64から選びます。送信元の署名仕様と一致させてください。Signature Prefixを指定した場合は、受信署名にもその接頭辞が必要です。

取得できる情報

認証条件に一致したHTTPリクエストの本文と付随情報を取得できます。
実際のキー内容・条件
受信本文。JSONの場合は送られたキーを持つデータです。形式は送信元のContent-Typeや内容に依存します。
受信ヘッダーの名前と値。
URLのクエリパラメータ。
HTTPメソッド。提供されている場合に含まれます。
生の本文。提供されている場合に含まれます。
  • 送信元によって の項目が変わります。例えば本文にorder_idがある場合は、後続ステップで を参照します。
  • 認証なし、Basic、Header、HMACの各条件を検証し、不一致の場合は業務データを出力しません。HTTP応答だけでフローの実行成功を判断しないでください。
  • サンプルデータを生成する操作と、送信元から実際にWebhookが届くことの確認は別です。実連携では送信元からテストしてください。

出力例(抜粋)

キーの使い方を示す架空例です。実際の値や全項目を示すものではありません。

Webhookの補足

Q. ヘッダー認証に失敗してもHTTP 200が返るのはなぜですか?

Webhookトリガーでは、ヘッダー認証に失敗した場合でも、送信元にHTTP 200が返されることがあります。
ただし、HTTP 200が返されたことは、認証やワークフローの実行が成功したことを意味しません。 認証ヘッダーの名前や値が一致しない場合、ワークフローが実行されず、実行履歴にも残らないことがあります。
Webhookが正常に処理されたか確認する際は、次の点をご確認ください。
  1. 送信元が指定した認証ヘッダーの名前と値が、workrun側の設定と一致しているか
  1. Webhook送信後に、workrunの実行履歴に対象の実行が記録されているか
HTTPステータスコードだけでフローの実行成功を判断しないようご注意ください。

Q. 認証失敗時にHTTP 401を返す設定はありますか?

Webhookトリガーの設定画面には、認証に失敗した際のHTTPステータスコードを401などに変更する設定項目はありません。
認証に失敗したリクエストへHTTP 401などを返す必要がある場合は、Webhookの前段で認証を行い、応答コードを制御する仕組みを別途設ける方法をご検討ください。
💡
送信元システムがHTTP 200のみで配信成功を判断する場合、workrun側で認証されず処理されなかったことを検知できない可能性があります。必要に応じて、送信元側の成功判定・再送条件もご確認ください。

参考: URLの種類

  • ライブURL: webhookUrl
  • テストURL: webhookUrl/test(フローは起動せずサンプルのみ)
  • 同期URL: webhookUrl/sync(最大30秒待機、必要に応じてReturn Responseと併用)

サンプルデータの生成

「テストトリガー」を開始すると、「サンプルデータの生成」ボタンが表示されます。
「サンプルデータの生成」をクリックすると、外部サービスから実際にWebhookを送信しなくても、workrun側でテスト用のサンプルデータを生成できます。生成したデータは、後続ステップで使用する項目の確認や、ワークフローの設定・テストに利用できます。
ただし、サンプルデータの生成はworkrun側でテスト用データを用意する機能です。送信元サービスのWebhook設定や、実際にWebhookがworkrunへ届くことを確認するものではありません。実際の連携まで確認する場合は、送信元サービスからWebhookを送信してテストしてください。

サンプルペイロード