コンテンツにスキップ
アカウントを作成
または
サインイン
Stripe ドキュメントのロゴ
/
AI に質問する
アカウントを作成
サインイン
始める
支払い
売上
プラットフォームおよびマーケットプレイス
資金管理
開発者向けリソース
概要
バージョン管理
変更ログ
API バージョンのアップグレード
SDK バージョンをアップグレードする
Essentials
SDK
API
テスト
Stripe CLI
    概要
    CLI をインストールする
    CLI を使用する
    オートコンプリートを有効にする
    CLI キー
    イベントのトリガー
    CLI をアップグレードする
サンプルプロジェクト
ツール
ワークベンチ
開発者ダッシュボード
Stripe Shell
Visual Studio Code をご利用の場合
機能
ワークフロー
イベントの送信先
Stripe 健全性アラートファイルのアップロード
AI ソリューション
エージェントツールキット
モデルコンテキストプロトコル
セキュリティとプライバシー
セキュリティ
Stripebot ウェブクローラー
プライバシー
Stripe を拡張する
Stripe Appsを構築する
Stripe アプリを使用する
パートナー
Partner Ecosystem
パートナー認定
ホーム開発者向けリソースStripe CLI

Stripe CLI を使用して Webhook イベントをトリガーする

サンドボックスで Webhook イベントをトリガーする方法について説明します。

サンドボックスで Webhook イベントをトリガーするには、次の 2 つの方法があります。

  • トリガーするイベントにつながるアクションを実行します。たとえば、Stripe API または Stripe ダッシュボードで顧客を作成すると、customer.created イベントが生成されます。
  • Stripe CLI でコマンドを実行して、イベントを自動生成します。

イベントのトリガー

Stripe CLI がサポートしているすべてのイベントの名前を確認するには、このコマンドを実行します。

Command Line
stripe trigger --help

特定のイベントをトリガーするには、次のコマンドを実行して <EVENT> をイベントの名前に置き換えます。

Command Line
stripe trigger <EVENT>

たとえば、このコマンドは payment_intent.succeeded イベントをトリガーします。

Command Line
stripe trigger payment_intent.succeeded

次に、ダッシュボードの Events page または stripe listen コマンドを使用してイベントを表示できます。

注

トリガーするイベントに応じて、Stripe CLI は複数の関連イベントを生成する場合があります。たとえば、stripe trigger price.created を実行する際、Stripe CLI では Price を作成するために Product を作成する必要があります。このため、product.created と price.created の 2 つのイベントが生成されます。

イベントをカスタマイズする

イベントを生成するために、Stripe CLI はいくつかの事前設定されたパラメーターを指定して Stripe API を呼び出します。たとえば、payment_intent.succeeded イベントをトリガーするために、Stripe CLI は Create PaymentIntent endpoint を amount パラメーターを 2000 に設定して呼び出します。これらの API パラメーターは、override フラグを使用して変更できます。

Command Line
stripe trigger <EVENT> --override <RESOURCE>:<PROPERTY>=<VALUE>

次に、override の例を示します。

Command Line
# 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

異なるリソースに対して複数のオーバーライドを組み合わせることもできます。

Command Line
stripe trigger price.created \ --override product:name=foo \ --override price:unit_amount=4200

変更可能なリソースとパラメーターを確認するには、Stripe CLI の GitHub リポジトリで、該当するトリガーを確認してください。

Advanced event customization

使用可能なイベントまたは override がユースケースに十分でない場合は、イベントの生成方法を説明する JSON ファイルを記述し、CLI を使用してそのイベントをトリガーできます。詳細については、Create and use fixtures を参照してください。

このページはお役に立ちましたか。
はいいいえ
  • お困りのことがございましたら 、サポートにお問い合わせください。
  • 早期アクセスプログラムにご参加ください。
  • 変更ログをご覧ください。
  • ご不明な点がございましたら、お問い合わせください。
  • LLM ですか?llms.txt を読んでください。
  • Powered by Markdoc