イベントをリッスンする

インストール済みのユーザーのアカウントでイベントをリッスンする

アプリでは Webhook を使用して、ユーザーのアカウントで発生しているイベントに関するアラートを受け取ることができます。これは、アプリで何らかの変更があった場合に、アプリの情報を同期したり、アプリ内でアクションをトリガーしたりするのに役立ちます。

アプリのバックエンドで Webhook イベントを処理します。
Stripe ダッシュボードで Webhook エンドポイントを登録し、連結アカウントでイベントをリッスンするを選択します。
Recommended Stripe ダッシュボードでテスト Webhook エンドポイントを登録します。アプリを本番モード、テストモード、またはサンドボックスにインストールできます。テストイベントを処理するテストエンドポイントを設定することをお勧めします。
必要な権限ごとに stripe apps grant permission を実行して、アプリに必要な権限を追加します。以下を置き換えます。
- PERMISSION_NAME には権限名が表示されます。
- EXPLANATION には、アクセス有効化についての説明が表示されます。この説明は、アプリのインストール時にユーザーに表示されます。

event_read 権限と、処理する特定のイベントに関連付けられた権限を追加する必要があります。イベントにどの権限が必要かについての情報は、イベントの権限でご確認ください。

たとえば、payment_intent.succeeded イベントと setup_intent.succeeded イベントを処理する場合は、次のコマンドを実行します。

これらのコマンドを実行した後のアプリのマニフェストファイルは次のようになります。

アカウントのユーザーのみに提供されている非公開アプリのイベントを受け取るには、以下のようにします。

Webhook を使用して Stripe アプリのイベント (ユーザーによるインストールやアンインストールなど) をリッスンし、次のリアクションをシステムのバックエンドで自動的にトリガーできるようにします。

Stripe Apps では、Stripe がサポートするイベントタイプに加えて次のイベントもサポートされます。

加盟店のアクション	結果としてアプリのバックエンドに送信される Webhook イベント
アプリを接続またはインストールする	account.application.authorized
アプリを接続解除またはアンインストールする	account.application.deauthorized

次を対象に、Webhook をローカルでテストできます。

Webhook をローカルでテストするには次のようにします。

Stripe CLI をインストールします。
次のようにアカウントを認証します。
端末ウィンドウを 2 つ開きます。
- ある端末ウィンドウで、イベント転送を設定します。
- 別の端末ウィンドウで、イベントをトリガーして Webhook との連携をテストします。

詳細については、Webhook エンドポイントのテストに関する Stripe ドキュメントをご覧ください。