メインコンテンツにスキップ

WorkflowsでWait for Webhookを使用する

ワークフローを一時停止し、外部システムのイベントがWebhookリクエストをトリガーするのを待つ方法。

対応者:Beth-Ann Sher

Wait for WebhookステップはWebhookリクエストを受信するまでワークフローを一時停止し、外部入力が必要なプロセスに最適です。

ワークフローが外部システム(例えば本人確認のためのサードパーティアプリ)と連携する必要があるとします。Wait for Webhookでは、外部システムからWebhook応答が送信されるまでワークフローが停止します。受信後、タスクは再開し、提供されたデータに基づいて処理を行います。

  • 本人確認:サードパーティサービスがユーザーの本人確認を完了するまでワークフローを一時停止します。

  • 支払い確認:取引を確認するために支払いプロバイダーからのWebhookを待ってから進行します。

  • 注文処理:在庫システムからの在庫状況更新が届くまで一時停止します。

  • 承認プロセス:サードパーティツールからの承認または拒否のステータスが送信されるまでワークフローを保留します。

この機能により、ワークフローは外部システムとシームレスに同期され、手動介入を減らし効率的に保ちます!


ワークフローにWait for Webhookを追加する

ワークフローにWait for Webhookステップを追加するには:

  1. Fin AI Agent > Workflowsに移動し、新しいワークフローを追加するか既存のものを開きます。

  2. 次にステップを追加をクリックし、Wait for Webhookを選択します。

  3. Wait for Webhookブロックを選択して設定します。

  4. ワークフローを公開します。


Wait for Webhookのベストプラクティス

  • ステップにわかりやすい名前を付けて、ステップ用に作成された一時変数を識別しやすくします。

  • Example requestを適切に設定し、Webhookコールバックで受け取るすべてのフィールドをデータオブジェクト内に含めます。

  • Webhookがステップの構造に合ったJSONボディを返すことを確認してください。JSON構造が更新されるとデータは受信されません。設定に不足フィールドがあると、そのフィールドはタスクでアクセスできなくなります。

  • 「コピー」ボタンをクリックしてWebhook URLをクリップボードにコピーします。Webhookがトリガーされるサードパーティサイトで、conversationIdが期待通りに渡されていることを確認してください。

注意:

  • Webhookエンドポイントは冪等性をサポートし、リクエストの安全な再試行と重複操作の防止を可能にします。リクエスト送信時には一意の値を持つ「Idempotency-Key」ヘッダーを含めてください。UUIDの使用を推奨します。冪等性キーは24時間で期限切れになります。

  • Wait for Webhookステップは無期限に待機せず、7日間の制限があります。7日以内にWebhookが受信されない場合、ステップはタイムアウトします。この制限を変更することはできません。

こちらの回答で解決しましたか?