概要
GET /jobs/{id} を繰り返しポーリングする代わりに、Webhook URL を指定して、ジョブ完了時に POST リクエストを受け取ることができます。これはより効率的で、不要な API 呼び出しを削減します。
Webhook の使用方法
任意の生成リクエストにX-Webhook-URL ヘッダーを追加します。ジョブが終了状態(completed、failed、または cancelled)に達すると、API は完全なジョブデータとともに指定した URL に POST リクエストを送信します。
Webhook ペイロード
ジョブが完了すると、Webhook URL は以下のジョブデータとともに POST リクエストを受け取ります:ベストプラクティス
すぐに応答する - 2xx ステータスコードを速やかに返してください。必要に応じて、Webhook データを非同期で処理してください。
- セキュリティのために HTTPS エンドポイントを使用する
- 重複配信に備えて冪等性を実装する
- デバッグのために Webhook 受信をログに記録する
Webhook vs ポーリング
HTTP リクエストを受信できるサーバーがある場合は Webhook を使用してください。クライアントサイドアプリケーションやパブリックエンドポイントを公開できない場合はポーリングを使用してください。
次のステップ
Job Lifecycle
ジョブの状態とステータスポーリングについて学ぶ
Code Examples
Webhook 処理を含む完全な例を見る