Amazon EventBridge にイベントを送信する

Amazon EventBridge は、AWS が提供するサーバーレスの、イベント駆動型サービスです。イベントを取り込み、変換し、送信することでアプリケーションを統合できます。イベントの送信先を使用する EventBridge を導入することで、Stripe からのイベントデータを AWS アカウントで直接受け取ることができるようになります。ご自身でトラフィックの処理し、導入のコードロジックを管理する必要はありません。イベントを受信すると、EventBridge はイベントを 20 以上のサポートターゲットに振り分けて処理するか、ビジネスの自動化を開始できます。

Amazon EventBridge にイベントを送信する

以下のステップを実行して、EventBridge でイベントを受信します。手順には、ワークベンチでの新しいイベントの作成と、AWS 管理コンソールでの EventBridge の設定が含まれています。

新しいイベントの送信先を追加する

ワークベンチ

サンドボックスでイベントを送信する

本番アカウントまたはサンドボックスを使用して、Amazon EventBridge にイベントを送信します。

ダッシュボードのワークベンチを使用するか、API を使用してプログラムでイベントの送信先を作成します。

ダッシュボード

API

ダッシュボードでイベントの送信先を作成するには、以下のようにします。

1. Workbench で Webhooks タブを開きます。
2. 新しい送信先を作成 をクリックします。
3. イベントの受信元を選択します。Stripe は、お客様のアカウント と連結アカウントの 2 種類の設定をサポートしています。アカウント を選択して、自分のアカウントからイベントをリッスンします。Connect アプリケーションを作成し、連結アカウントからのイベントをリッスンする場合は、連結アカウント を選択します。

組織のイベント送信先からのイベントをリッスンする

組織アカウントでイベントの送信先を作成する場合は、アカウント を選択して、組織内のアカウントからのイベントをリッスンします。組織のメンバーとして Connect プラットフォームがあり、すべてのプラットフォームの連結アカウントからのイベントをリッスンする場合は、連結アカウント を選択します。

1. この送信先で受信するイベントタイプを選択します。次に、続行 をクリックします。
2. 送信先タイプとして Amazon EventBridge を選択し、続行 をクリックします。
3. 次の情報を入力します。
   • AWS アカウント ID: イベントを受信する EventBridge インスタンスをホストする AWS アカウント。
   • AWS リージョン: イベントを受信する EventBridge インスタンスをホストする AWS リージョン。
   • (任意) 送信先の名前: Stripe でのこのイベントの送信先リソースの一意の名前。名前を指定しない場合は、ランダムな名前が生成されます。後で変更できます。
   • (任意) 説明: イベントの送信先のインスタンスを区別する説明。これは後で変更できます。
4. 送信先を作成 をクリックします。

Webhook タブで新しい Webhook を登録する

パートナーイベントソースを関連付ける

AWS コンソール

イベントの送信先を設定すると、Stripe は設定時にお客様が指定した AWS アカウントとリージョンにパートナーイベントソースを作成します。イベントの受信を開始するには、イベントの送信先を作成してから 7 日以内にこのイベントソースをイベントバスに関連付ける必要があります。この期間内に関連付けなかった場合、Amazon は保留中のイベントソースを自動的に削除します。イベントソースが削除されると、Stripe のイベントの送信先は自動的に無効になり、イベントを受信するには新しい送信先を作成する必要があります。

1. AWS コンソールの EventBridge の下で、左側のパネルの統合セクションに表示されているパートナーイベントソースページに移動します。

1. コンソール上部にあるリージョンドロップダウンリストを使用して、ワークベンチでイベントの送信先を設定したときに選んだリージョンを選択します。

1. ドロップダウンから、新しく作成されたパートナーイベントソースを選択します。ワークベンチのイベントソース ARN を検索するには、イベントの送信先を選択します。パートナーソースは event-source/aws.partner/stripe.com/{UNIQUE_ID} という ARN と部分的に一致しています。次に、イベントバスと関連付けるをクリックします。

1. 必要に応じて、このイベントバスに付与するアクセス許可を選択し、関連付けるをクリックします。

EventBridge ルールを作成する

AWS コンソール

EventBridge では、お客様が定義するルールに基づきイベントがグループ化され、振り分けられます。イベントの送信先を作成し、そのパートナーイベントソースをイベントバスに関連付けた後で、イベントバスで受信したイベントの処理方法を EventBridge に確実に伝えるために、ルールを定義する必要があります。以下のステップを複数回繰り返して、複数のルールを定義できます。

1. AWS マネジメントコンソールに移動して、ルールをクリックします。

1. ルールを作成をクリックして、ルールの名前と説明を指定します。

1. ドロップダウンからイベントバスを選択します。イベントバスを見つけるには、Workbench に移動し、Webhook タブで送信先を選択してからイベントソース ARN と同じ名前の Event source ARN フィールドを表示します。その後に次へをクリックします。
2. Stripe イベントはパートナーイベントなので、イベントソースの下で AWS イベントまたは EventBridge パートナーイベントを選択します。

1. (任意) サンプルの Stripe イベントを含めます。
2. 作成のメソッドで、パターンフォームを使用するを選択して、事前定義されたパターンを使用します。あるいは、カスタムのイベントパターンを作成することもできます。

1. イベントパターンの下で、イベントソースとして EventBridge パートナーを選択します。
2. イベントパターンの下で、パートナーとして Stripe を選択します。
3. ルールを作成する適切なイベントタイプを選択するか、すべてのイベントを選択して、このルールをすべてのイベントタイプに適用し、次へをクリックします。
4. このルールでイベントを送信するターゲットを選択して、次へをクリックします。

推奨事項

Stripe は、各イベントバスで CloudWatch ログターゲットを作成して、イベントの送信先の監視を有効にすることをお勧めしています。その他の一般的なアーキテクチャーパターンを EventBridge および Stripe イベントとともに使用することを検討してください。

1. オプションのタグを追加して、次へをクリックします。
2. ルールを確認し、必要に応じて変更を加えたら、ルールを作成をクリックします。

これで、Stripe イベントは、EventBridge とルールで定義された対応するターゲットに正常に送信されます。

テストイベントをトリガーする

To send test events, trigger an event type that your event destination is subscribed to by manually creating an object in the Stripe Dashboard. Learn how to trigger events with Stripe for VS Code.

stripe trigger payment_intent.succeeded
Running fixture for: payment_intent
Trigger succeeded! Check dashboard for event details.

イベント送信の動作

このセクションは、Stripe が Amazon EventBridge にイベントを送信する際に想定されるさまざまな動作を理解するのに役立ちます。

自動での再試行

本番環境では、Stripe は指数バックオフを使用して最長 3 日間、送信先へのイベントの配信を試行します。イベント送信先のイベントの配信タブで、該当がある場合、次回の再試行のタイミングを確認します。Stripe はサンドボックスで作成されたイベントの配信を数時間のうちに 3 回再試行します。Stripe が再試行するときに、送信先が無効化または削除されていた場合、そのイベントの以降の再試行は行われません。ただし、Stripe が再試行できるようになる前にイベントの送信先を無効にして、再び有効にした場合は、以降の再試行が引き続き行われます。

手動での再試行

There are two ways to manually retry events:

• In the Stripe Dashboard, click Resend when looking at a specific event. This works for up to 15 days after the event creation.
• With the Stripe CLI, run the stripe events resend <event_id> --webhook-endpoint=<endpoint_id> command. This works for up to 30 days after the event creation.

イベントの順序付け

Stripe は、イベントが生成された順序で配信されることを保証しません。たとえば、サブスクリプションを作成することで、次のイベントが生成されるとします。

• customer.subscription.created
• invoice.created
• invoice.paid
• charge.created (支払いが付随する場合)

イベントの送信先が、特定の順序でのイベントの受信に左右されないようにしてください。配送を適切に管理できるように準備します。API を使用して不足しているオブジェクトを取得することもできます。たとえば、最初に受信したイベントが invoice.paid であった場合は、それに含まれる情報を使用して請求書、支払い、サブスクリプションの各オブジェクトを取得できます。

API のバージョン管理

The API version in your account settings when the event occurs dictates the API version, and therefore the structure of an Event sent to your destination. For example, if your account is set to an older API version, such as 2015-02-16, and you change the API version for a specific request with versioning, the Event object generated and sent to your destination is still based on the 2015-02-16 API version. You can’t change Event objects after creation. For example, if you update a charge, the original charge event remains unchanged. As a result, subsequent updates to your account’s API version don’t retroactively alter existing Event objects. Retrieving an older Event by calling /v1/events using a newer API version also has no impact on the structure of the received event. You can set test event destinations to either your default API version or the latest API version. The Event sent to the destination is structured for the event destination’s specified version.

イベント送信先のステータス

Amazon EventBridge の送信先には、イベント受信への対応状況を示すいくつかのステータスがあります。

• 有効: イベントの送信先はイベントバスに正常に関連付けられています。EventBridge のルールを正しく設定すると、選択したイベントコンシューマーでイベントを受信します。
• 無効: Stripe は Amazon EventBridge にイベントを送信できていません。送信先を手動で無効化したか、あるいは AWS の設定ミスにより Stripe が自動で無効化するとこのステータスになります。
• 保留中: イベントの送信先で AWS のパートナーイベントソースが適切に作成された後で、そのイベントソースをイベントバスに関連付ける必要があります。この関連付けを行うまで、送信先は保留中のステータスで維持され、イベントを一切受信しません。関連付けした時点でステータスは有効に変わります。

イベントの構造

EventBridge は Stripe の event JSON オブジェクトを最上位の detail フィールド内にラップする独自のイベント構造を使用します。

次の例は、EventBridge からの customer.created イベントペイロードを示したものです。

{
   "version":"0",
   "id":"17e8dff5-d6cd-3770-ace9-aeac02b6ac3f",
   "detail-type":"customer.created",
   "source":"aws.partner/stripe.com/ed_61PgtRTG5aTCIz98516PLsRGLISQK0Otk6FWKjBrcDia",
   "account":"506417113029",
   "time":"2024-03-07T18:27:56Z",
   "region":"us-west-2",
   "resources":[

Stripe が応答を待つイベントタイプをサポートする

Stripe はほとんどのイベントタイプを非同期で送信します。ただし、特定のイベントタイプに対しては、Stripe は応答を待ちます。イベントの送信先からの応答の有無は、これらの特定のイベントタイプに関する Stripe のアクションに直接影響を及ぼします。

Amazon EventBridge の送信先では、応答が必要なイベントタイプに対して制限付きのサポートが提供されます。

• Amazon EventBridge の送信先の issuing_authorization.request イベントタイプに登録することはできません。代わりに、Webhook エンドポイントを設定してこのイベントタイプに登録します。issuing_authorization.request を使用することで、購入リクエストをリアルタイムで承認できます。これには、送信先がイベントに応答してリクエストを承認または拒否する必要があります。EventBridge は、Stripe への応答をコンシューマーに送信する前に処理します。したがって、この送信先タイプは、このイベントタイプを使用して支払いを承認することはできません。
• Amazon EventBridge を使用する場合は、checkout_sessions.completed に登録できます。ただし、ウェブサイトに直接 Checkout を埋め込んだり、Stripe がホストする支払いページに顧客をリダイレクトする場合、これはリダイレクト動作を処理しません。Amazon EventBridge に checkout_sessions.completed イベントを送信しても、リダイレクトの動作には影響しません。Checkout のリダイレクト動作に影響を与えるには、このイベントタイプを Webhook エンドポイントで処理します。

EventBridge と Stripe イベントで一般的なアーキテクチャーパターン

Stripe とともに Amazon EventBridge を使用する際は、次のアーキテクチャーパターンを検討してください。

• Lambda でサーバーレス機能を起動してビジネスの自動化を定義する: EventBridge から Lambda に Stripe イベントを送信して、支払い成功後の配送ラベルの作成など、サーバーレスのコンピューティング機能を起動します。
• CloudWatch によるイベント監視の有効化: イベントを EventBridge から CloudWatch Logs に送信し、イベントを対話形式で検索および分析できるログデータとして格納します。CloudWatch を使用して使用形態とエラーを監視します。エラー (EventBridge ルールに違反した場合など) へのアラートを設定することを検討してください。
• Step Functions によるローコードおよびノーコードのワークフローの起動: イベントを StepFunction ワークフローに送信し、そこから顧客にトライアルの終了日が近づいていることを通知するなどのビジネスシナリオを開始します。
• Simple Notification Service (SNS) または Simple Queue Service (SQS) による内部システムへのイベントのファンアウト: イベントを SNS または SQS に送信して、Stripe イベントデータを社内チームが所有および処理できるようにファンアウトします。