Stripe CLI を使用して Webhook イベントをトリガーする
テスト環境で Webhook イベントをトリガーする方法をご紹介します。
テスト環境で Webhook イベントをトリガーするには、以下の 2 つの方法があります。
- トリガーするイベントにつながるアクションを実行します。たとえば、Stripe API または Stripe ダッシュボードで顧客を作成すると、
customer.
イベントが生成されます。created - Stripe CLI でコマンドを実行して、イベントを自動生成します。
このガイドでは、Stripe CLI を中心に説明します。
イベントのトリガー![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
Stripe CLI がサポートしているすべてのイベントの名前を確認するには、このコマンドを実行します。
stripe trigger --help
特定のイベントをトリガーするには、<EVENT>
をイベント名に置き換えて、このコマンドを実行します。
stripe trigger <EVENT>
たとえば、このコマンドは payment_
イベントをトリガーします。
stripe trigger payment_intent.succeeded
次に、Stripe ダッシュボードのイベントページで、または stripe listen コマンドを使用してイベントを表示できます。
注
トリガーするイベントに応じて、Stripe CLI は複数の関連イベントを生成する場合があります。たとえば、stripe trigger price.
を実行する際、Stripe CLI では Price を作成するために Product を作成する必要があります。このため、product.
と price.
の 2 つのイベントが生成されます。
イベントをカスタマイズする![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
イベントを生成するために、Stripe CLI はいくつかの事前設定されたパラメーターを指定して Stripe API を呼び出します。たとえば、payment_
イベントをトリガーするために、Stripe CLI は、amount
パラメーターを 2000
に設定して PaymentIntent エンドポイントを呼び出します。これらの API パラメーターは、override
フラグを使用して変更できます。
stripe trigger <EVENT> --override <RESOURCE>:<PROPERTY>=<VALUE>
上書きの使用例をいくつかご紹介します。
# Set a top-level parameter stripe trigger customer.created --override customer:name=Bob # Set a nested parameter stripe trigger customer.created --override customer:"address[country]"=FR # Append an element to the end of a list stripe trigger customer.created --override customer:"preferred_locales[]"=FR # Replace an element of a list stripe trigger customer.created --override customer:"preferred_locales[0]"=FR # Set a parameter inside a list stripe trigger customer.subscription.created --override subscription:"items[0][price]"=price_xxx
異なるリソースに対して複数のオーバーライドを組み合わせることもできます。
stripe trigger price.created \ --override product:name=foo \ --override price:unit_amount=4200
変更可能なリソースとパラメーターを確認するには、Stripe CLI の GitHub リポジトリで、該当するトリガーを確認してください。
イベントの高度なカスタマイズ![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg)
使用可能なイベントまたはオーバーライドが実際のユースケースに対して十分ではない場合、イベントの生成方法を指定する JSON ファイルを作成し、CLI を使用してそのイベントをトリガーできます。詳細については、API リファレンスをご覧ください。