イベント通知ハンドラーを使用して受信する Webhook を処理する公開プレビュー
公開プレビュー
イベント通知ハンドラーはパブリックプレビューで利用可能です。
この機能は、パブリックプレビューで EventBridge を使用するイベント宛先をサポートしていません。
各 SDK には、Stripe Webhook の解析と検証の仕組みをカプセル化した専門クラスを作成しています。イベント通知ハンドラーは、受信する Webhook の検証、解析、そしてビジネスロジックへのルーティングを行います。
この機能を使うには、処理したい各イベントタイプごとに関数を書く必要があります。これらの機能をハンドラーに登録すると、対応するイベント通知を受け取ったときに Stripe がそれらを呼び出します。
はじめに
イベント通知ハンドラーを使用するには、以下の SDK バージョン (またはそれ以上のバージョン) を使用する必要があります。
- Java:
v31.2. 0-beta. 1 - Python:
v14.2. 0b1 - Ruby:
v18.2. 0-beta. 1 - PHP:
v19.2. 0-beta. 1 - Go:
v84.2. 0-beta. 1 - Node:
v20.2. 0-beta. 1 - .NET:
v50.2. 0-beta. 1
フォールバックコールバックを作成する
特定のイベントタイプに対して専用コールバックが登録されていないときに実行される関数を書いてください。EventNotification、StripeClient、イベントに関する追加情報を受け取ります。
この関数は、予期せぬイベントの受信事実を記録したり、予期せぬ状態の警告エラーをスローしたりします。また、SDK に型がないイベントを扱う場合は、この関数にビジネスロジックを追加することもできます。
移行の一環として、すべての Webhook エンドポイントコードをこの関数に移行することを検討してください。その後、個々のイベントタイプをそれぞれの関数に移行できます。
ハンドラーを初期化する
Webhook エンドポイントで EventNotificationHandler を初期化し、フォールバックコールバックを渡します。StripeClient には、このステップを簡素化する便利なメソッドがあります。
コールバックを記述して登録する
次に、特定のイベントタイプを処理する関数を作成します。これは、2025 年 9 月にリリースされた Clover API バージョンでリリースされたイベントタイプを使用します。
コールバックは正しいクラスにイベント通知がキャストされて届きます。また、通知の context に紐づく StripeClient も提供されるため、アカウント ID を管理せずに追加の API コールを簡単に行えます。
コールバックは 0 件またはそれ以上登録できます。登録しない場合、すべてのイベントがフォールバックコールバックにルーティングされます。
イベントを処理する
POST の受信ボディをハンドラーに送信します。これにより、Webhook エンドポイントの元のコードの大部分が置き換えられます。