HTTP Webhook コネクタについて

Integration Service で HTTP Webhook コネクタを設定して、ポーリングなしで外部アプリケーションからリアルタイムのイベント ドリブン コールバックを受信します。

Webhook を使用すると、アプリケーションは外部システムにリアルタイムで通知できるため、頻繁なポーリングの必要性が減り、API 呼び出しを最小限に抑えることができます。システムは、更新を定期的にチェックする代わりに、関連する変更が発生したときにのみイベントベースのコールバックを受信します。

UiPath HTTP Webhook コネクタを使用すると、ベンダー アプリケーションから直接ワークフローをトリガーできます。アウトバウンド Webhook 通知をサポートするサードパーティ アプリケーションは、コネクタ カタログに含まれていなくても、イベントに対するインスタント トリガーを作成できます。

また、イベント データ フィルターを適用して、Webhook イベントによってワークフローがトリガーされる条件を正確に指定することもできます。

動作のしくみ

HTTP Webhook トリガーは、動的なパブリック コールバック URL を生成します。この URL は、Orchestrator でトリガーが作成された後に、ベンダー アプリケーションの Webhook 設定にコピーして設定してください。

ベンダー システムでイベントが発生すると、次のようになります。

1. ベンダーは、設定された URL にイベント ペイロードを送信します。
2. Integration Service はペイロードを受信し、設定したイベント データ フィルターに照らして評価します。
3. 一致が見つかった場合、Integration Service は Orchestrator を介してワークフローの実行をトリガーします。

Webhook ペイロードは、他のトリガー イベントと同じ方法で処理されます。また、このコネクタではオプションの ヘッダーベースの認証もサポートされています。これにより、ベンダーは設定されたヘッダー値を使用して、Webhook を配信するたびに UiPath に対して自身を認証できます。

詳細については、「 Webhook コネクタを使用する」をご覧ください。

接続を作成し、ベンダーから要求された場合のチャレンジ検証の設定方法については、「 HTTP Webhook 認証」を参照してください。

セキュリティ

HTTP Webhook コネクタは、補助的なセキュリティ メカニズムを 2 つ提供しており、どちらも接続の作成時に設定します。

メカニズム	機能	使用すべきタイミング
チャレンジの検証	イベントを送信する前に、ベンダーに UiPath Webhook URL が有効であることを確認できるようにします。	ベンダーがハンドシェイクを必要とする場合 (Slack、Meta など)。
ヘッダーベースの認証	HTTP ヘッダー (例: X-API-Key) で運ばれた共有シークレットを使用して、すべての受信 Webhook 要求を検証します。構成されているヘッダー値を保持しない要求は、HTTP 401 で拒否されます。	権限のない呼び出し元が Webhook URL に投稿するのを防ぎ、ベンダーが送信 Webhook 配信にカスタム ヘッダーを設定できるようにする場合。

設定について詳しくは、「 HTTP Webhook 認証」をご覧ください。

レート制限

Webhook によってトリガーされるイベントには、次の制限があります。

• テナントあたり 1 分あたり 500 イベント
• 接続あたり 1 分あたり 100 イベント

制限事項

• 設計時トリガーのデバッグは現在利用できません。
• JSON 形式の要求のみがサポートされています。
• サポートされる Webhook ペイロードの最大サイズは 14 MB です。この制限を超えるリクエストは拒否され、トリガー イベントはディスパッチされません。

よくある質問

Webhook URLをプロバイダーのUIに貼り付けましたが、それでも検証が通過しないのはなぜですか?

検証は、Orchestrator でトリガーが作成され、チャレンジが正しく設定されている場合にのみ成功します。UiPath ではチャレンジ検証は UiPath 側では行われません。ターゲットとの信頼関係を確立するために、検証は完全にプロバイダー側で行われます。

チャレンジの設定が間違っているのに、なぜコネクションが正常に作成されるのですか?

現在、UiPath ではプロバイダーの本人確認/検証手順を検証していません。この検証は、すべてベンダーが行います。その結果、プロバイダーのチャレンジ検証が実際にはプロバイダー側で失敗した場合でも、UiPath のコネクションはアクティブに見える場合があります。

Orchestrator で作成した Webhook からの応答はどのように使用しますか?

ワークフローで [ トリガー イベントを取得 ] アクティビティを使用し、入力引数として UiPathEventObjectId (datatype=Text) を渡します。このアクティビティは、Webhook から受け取った本文とヘッダーの両方を返します。

Webhook の応答は JSON 文字列です。コンポーネントの一部をワークフローで使用するにはどうすればよいですか?

[JSON を逆シリアル化] アクティビティを使用して、文字列を JObject に変換します。その後、個々のフィールドに簡単にアクセスできるようになります。

Webhook イベントを UiPath に送信する際にベンダーの認証を要求することはできますか?

はい。接続を作成または編集するときにヘッダー ベースの認証 を有効化し、ベンダーの Webhook 設定で一致するヘッダーを設定します。設定手順については、「 HTTP Webhook 認証」をご覧ください。

ベンダーが独自の署名スキーム ( X-Hub-Signature-256など) を使用しています。ヘッダーベースの認証を引き続き使用できますか?

いいえ。ヘッダーベースの認証では、静的な事前共有ヘッダー値を使用します。署名ベースのベンダーは、ペイロードと共有シークレットを使用して、すべての要求に対して新しい HMAC を計算します。現在、UiPath はベンダー固有の署名を検証しません。これらのベンダーで利用可能なセキュリティ メカニズムは、URL の機密性とベンダーのチャレンジ検証ハンドシェイクです。