HTTP Webhook コネクタについて

Integration Service Connector for HTTP Webhook in Automation Suite - 頻繁なポーリングを行うことなく、外部アプリケーションからリアルタイムのイベントベースのコールバックを可能にします。

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

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

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

動作のしくみ

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

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

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

Webhook ペイロードは、他のトリガー イベントと同じ方法で処理されます。

詳細については、「 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 に変換します。その後、個々のフィールドに簡単にアクセスできるようになります。