イベントの送信先ベータ
Stripe から Webhook エンドポイントとクラウドサービスにイベントを送信します。
イベントの送信先を設定して、Stripe からのイベントを Webhook エンドポイントや Amazon EventBridge など、複数の送信先タイプで受信します。
ユースケース![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Stripe のシステムを構築する際、自社のアプリが Stripe アカウントからイベントをリアルタイムで受信できるようにすることをお勧めします。こうすることで、バックエンドシステムはアクションへの応答とアクションの実行を適宜行うできます。
イベントの送信先では、Stripe はアカウントからリアルタイムのイベントデータのプッシュを行うことで、次のようなバックエンドアクションを実行できるようにします。
- 顧客が支払いを確認したときにユーザーに通知を送る
- 顧客が支払いに対して不審請求を申請したときに、内部の申し立ての調整プロセスを開始する
- 継続的なサブスクリプション支払いに成功したときにユーザーにアクセス権を付与する
対応している配送先タイプ![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Amazon EventBridge を使用して AWS アカウントにイベントを送信するか、Webhook エンドポイント経由で HTTPS エンドポイントにイベントを送信します。
イベントの概要![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Stripe はイベントデータを生成して、アカウントのアクティビティーに関する最新情報を通知します。
イベントが発生すると、Stripe は新しい Event (イベント) オブジェクトを作成します。指定した送信先が Event を受信した後に、アプリはバックエンドアクションを実行できます (たとえば、payment_
イベントを受信した後に、配送業者の API を呼び出して、配送の予定を設定します)。
Stripe がイベントの送信先に送る Event (イベント) は、変更されたオブジェクトのスナップショットを提供します。該当する場合、変更を示す previous_
プロパティを含むことがあります。
Stripe がイベントの送信先に送るイベントタイプの一覧をご覧ください。
1 つの API リクエストで複数のイベントが作成されることがあります。たとえば、顧客に新しいサブスクリプションを作成すると、customer.
イベントと payment_
イベントが作成される場合があります。イベントの送信先ごとに、登録するイベントを選択します。
イベントペイロードのサンプル![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
以下のペイロードは、新しいサブスクリプションの作成時に発生する invoice.
イベントの例です。
{ "object": { "id": "in_1KnN0G589O8KAxCGfVSpD0Pj", "object": "invoice", "account_country": "US",
イベントの権限![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
ダッシュボードでイベントを表示するには、ユーザーアカウントに管理者または開発者のロールを割り当てます。API を使用してイベントを取得するには、デフォルトですべてのイベントタイプを表示できるシークレット API キーを使用するか、特定のイベントタイプのリソースに対する Read
アクセス権が有効になった制限付きの API キーを使用できます。たとえば、制限付きの API キーで payment_
リソースへの Read
アクセスを許可して、プログラムで payment_
を取得することが可能です。
イベントの保持![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
ワークベンチのイベントタブでは過去 13 カ月以内に作成されたイベントにアクセスできますが、イベント送信セクションから手動で再送信したり表示できるのは 15 日未満の送信に限られます。30 日以上前のイベントについては、元のイベントデータの省略フィールドのみを含むサマリービューにアクセスできます。
Retrieve event API と List event API を使用して、過去 30 日以内のイベントにアクセスできます。
イベントの送信先を無効にする![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
イベントの送信先は無効にすることもできます。無効にすると、Stripe はその送信先へのイベントの送信を停止します。送信先を再度有効にすると、Stripe はその送信先へのイベントの送信を再開します。