Webhookとは？

Webhookとは、あるシステムで特定のイベントが発生した際に、その結果を他のシステムに通知する方法です。この用語は、2007年にJeff Lindsayのコンピュータープログラミング用語の「フック（hook）」から派生して作られました。

例えば、Stripeで決済が完了したり、ブログにコメントが投稿されたりするイベントが発生すると、そのシステムは登録されたWebhook URL（他のシステムのURL）にイベントの結果を通知します。

従来の方式との比較

ポーリングとWebhookを理解するために、ECサイトの例を見てみましょう。Aシステムで顧客が商品を決済すると、決済リクエストが決済サービス（例：Stripe）に送られます。

短いポーリング（Short Polling)：短いポーリングは、AシステムからStripeシステムに決済リクエストを送り、決済が完了するまで状態を継続的に確認する方法です。これはサーバーリソースを多く消費します。
長いポーリング（Long Polling)：長いポーリングは、AシステムがStripeシステムにHTTPリクエストを送り、Stripeシステムが結果を返すまで接続を維持する方法です。短いポーリングよりも効率的ですが、それでもサーバーリソースを多く消費します。
Webフック（Webhook）：Webhookは、AシステムがStripeシステムに決済リクエストを送り、Stripeが決済を処理した後、Aシステムが事前に登録したWebhook URLに決済結果を送信する方法です。これにより、不要なリソースの浪費を防ぎ、即時の更新が可能となります。

Webhookのためのベストプラクティス

Webhookの利点を最大限に活用するためには、以下のベストプラクティスを守ることが重要です。

1. フォールバックポーリングメカニズム

システムがダウンしたり、ネットワークに問題が発生することがあるため、リクエスト結果を確認するためのフォールバックメカニズムを用意しましょう。

2. Webhookのセキュリティ

Webhookを使用する際は、セキュリティが非常に重要です。Webhookのリクエストが信頼できる出所からのものであることを確認するために、認証手続きを導入して有効性を検証しましょう。

3. Webhookの冪等性

冪等性とは、同じWebhookが複数回送信されても問題が発生しないようにすることを意味します。必ず一意の識別子を使用し、各イベントを一度だけ処理するように実装しましょう。

4. Webhookの過負荷処理

ウェブサイトやアプリケーションの人気が急上昇すると、Webhookのトラフィックも急増する可能性があります。キューを使用してWebhookイベントの受信と処理を分離することで、高いトラフィックでもスムーズに動作するシステムを提供できます。

5. リアルタイム要件の評価

Webhookはほとんどの場合非常に有用ですが、マイクロ秒単位の遅延が重要な場合には適していないことがあります。時間に非常に敏感な作業の場合、低いオーバーヘッドと迅速な更新を提供するためにソケットの使用を検討しましょう。

結論

Webhookは効率的で即時の更新を可能にします。しかし、これを適切に活用するためには、セキュリティの強化、冪等性の維持、過負荷処理、フォールバックメカニズムの準備、リアルタイム要件の評価など、いくつかの事項を考慮する必要があります。これらのベストプラクティスを守り、安定して信頼できるシステムを構築することで、Webhookの利点を最大限に活用することができます。

参考