ワークベンチで Webhook エンドポイントを設定するベータ
このガイドでは、ワークベンチを使用して Webhook エンドポイントを設定する方法を説明しています。
ワークベンチで Webhook エンドポイントを登録する
ワークベンチで Webhook エンドポイントを登録するには、以下を行います。
- ダッシュボードでワークベンチを開き、Webhook タブをクリックします。
- 新しい Webhook エンドポイントを登録するをクリックします。
- 使用する Event (イベント) オブジェクトの API バージョンを選択します。
- Connect をご使用の場合は、連結アカウントのイベントをリッスンできます。使用していない場合はアカウントのイベントを選択します。
- Webhook エンドポイントに送信するイベントタイプを選択して、続けるをクリックします。
- Stripe の Webhook を送信するエンドポイント URL と、オプションとしてエンドポイントの説明を指定します。
- 送信先を作成するをクリックして、Webhook エンドポイントを作成します。
Webhook タブで新しい Webhook エンドポイントを登録する
既存の Webhook エンドポイントを設定する
ワークベンチの Webhook タブで、既存の Webhook エンドポイントを更新または削除できます。また、登録済みの Webhook エンドポイントを一時的に無効にすることもできます。Stripe は、Webhook エンドポイントが無効になっている間に生成されたイベントの再送信を試行しません。この他、Webhook エンドポイントの管理をプログラムで行うこともできます。
イベントの送信を表示する
イベントの送信先を表示するには、Webhook で Webhook エンドポイントを選択して、イベントの送信先タブを選択します。
イベントの送信先タブには、イベントのリストと、各イベントが Delivered
、Pending
、Failed
のいずれであるかが表示されます。イベントをクリックして、Delivery attempts
を表示すると、以前行われた配信の試行の HTTP ステータスコードや、保留中になっているイベントの今後の配信時刻が示されます。
Webhook エンドポイントのイベントの送信先タブでイベント送信の試行を表示します。
イベントの送信を再試行する
本番環境では、Stripe は指数バックオフを使用して最長 3 日間、お客様の Webhook エンドポイントに特定のイベントの配信を試行します。ワークベンチに掲載されている Webhook エンドポイントのイベントの送信先セクションで、次回の再試行が発生する時期を表示できます。
テスト環境では、Stripe は数時間にわたって 3 回再試行します。これ以降は、ワークベンチの Webhook タブを使用して、希望のエンドポイントに記載されているイベントの送信先に移動し、自身の Webhook エンドポイントに対して各イベントの送信を手動で再試行できます。逃したイベントに対してクエリを実行して、任意の期間のデータを照合することもできます。
Webhook エンドポイントのイベントの送信先タブを使用して、イベントの送信を再試行します。