イベントをリッスンする

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

始める

1. アプリのバックエンドで Webhook イベントを処理します。
2. Stripe ダッシュボードで Webhook エンドポイントを登録し、連結アカウントでイベントをリッスンするを選択します。
3. RecommendedStripe ダッシュボードでテスト用 Webhook エンドポイントを登録します。アプリは、本番環境、テスト環境、またはサンドボックスでインストールできます。また、テストイベントを処理するためのテストエンドポイントを設定しておくこともお勧めします。
4. 必要な権限ごとに stripe apps grant permission を実行して、アプリに必要な権限を追加します。
   Command Line

   stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

   以下を置き換えます。
   • PERMISSION_NAME には権限名が表示されます。
   • EXPLANATION には、アクセス有効化についての説明が表示されます。この説明は、アプリのインストール時にユーザーに表示されます。

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

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

stripe apps grant permission "event_read" "Read webhook event data"
stripe apps grant permission "checkout_session_read" "Read Checkout Session data in webhook events"
stripe apps grant permission "payment_intent_read" "Read PaymentIntent data in webhook events"
stripe apps grant permission "setup_intent_read" "Read SetupIntent data in webhook events"

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

{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "permissions": [
    {
      "permission": "event_read",
      "purpose": "Read webhook event data"
    }
    {
      "permission": "checkout_session_read",
      "purpose": "Read Checkout Session data in webhook events"
    }
    {
      "permission": "payment_intent_read",
      "purpose": "Read PaymentIntent data in webhook events"
    }
    {
      "permission": "setup_intent_read",
      "purpose": "Read SetupIntent data in webhook events"
    }
  ],
}

アカウントでイベントをリッスンする

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

1. アプリのバックエンドで Webhook イベントを処理します。
2. Stripe ダッシュボードで Webhook エンドポイントを登録します。

アプリに関するイベント通知を受け取る

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

• ユーザーアカウントの作成
• 権限の更新
• ユーザーアカウントの無効化およびデータの削除

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

Webhook をローカルでテストする

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

• 貴社のアカウントのすべてのユーザーのみが入手でき、自身のアカウントのイベントをリッスンするアプリ
• Stripe App Marketplace で入手でき、貴社のアプリをインストールしたアカウントのイベントをリッスンするアプリ

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

1. Stripe CLI をインストールします。

2. 次のようにアカウントを認証します。

   Command Line

   stripe login

3. 端末ウィンドウを 2 つ開きます。

   • ある端末ウィンドウで、イベント転送を設定します。

     App Marketplace での公開

     貴社のアカウントのみの非公開アプリ

     Command Line

     stripe listen --forward-connect-to localhost:{{PORT}}/webhook

   • 別の端末ウィンドウで、イベントをトリガーして Webhook との連携をテストします。

     App Marketplace での公開

     貴社のアカウントのみの非公開アプリ

     Command Line

     stripe trigger --stripe-account {{EVENT_NAME}}

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