Webhook-Ereignisse mit der Stripe CLI auslösen

Erfahren Sie, wie Sie Webhook-Ereignisse in einer Sandbox auslösen.

Es gibt zwei Möglichkeiten, Webhook-Ereignisse in einer Sandbox auszulösen:

Führen Sie die Aktionen aus, die zu dem Ereignis führen, das Sie auslösen möchten. Wenn Sie beispielsweise einen Kunden/eine Kundin mit der Stripe API oder im Stripe-Dashboard erstellen, wird ein das Ereignis customer.created generiert.
Führen Sie einen Befehl mit der Stripe CLI aus, um das Ereignis automatisch zu generieren.

Dieser Leitfaden behandelt die Stripe CLI.

Ereignisse auslösen

Führen Sie diesen Befehl aus, um den Namen aller von der Stripe CLI unterstützten Ereignisse anzuzeigen.

Command Line
stripe trigger --help

Um ein bestimmtes Ereignis auszulösen, führen Sie dies aus, indem Sie <EVENT> durch den Namen des Ereignisses ersetzen.

Command Line
stripe trigger <EVENT>

Dieser Befehl löst beispielsweise das Ereignis payment_intent.succeeded aus.

Command Line
stripe trigger payment_intent.succeeded

Dann können Sie das Ereignis auf der Ereignisseite des Stripe-Dashboards anzeigen oder den Befehl stripe listen verwenden.

Notiz

Abhängig von dem Ereignis, das Sie auslösen, kann die Stripe CLI mehrere verwandte Ereignisse generieren. Wenn Sie beispielsweise stripe trigger price.created ausführen, muss die Stripe CLI ein Produkt erstellen, um einen Preis zu erstellen, sodass zwei Ereignisse generiert werden: product.created und price.created.

Ereignisse anpassen

Um Ereignisse zu generieren, ruft die Stripe CLI die Stripe API mit einigen vordefinierten Parametern auf. Um beispielsweise das Ereignis payment_intent.succeeded auszulösen, ruft die Stripe-CLI den Endpoint „create PaymentIntent“ mit dem Parameter amount auf, der auf 2000 festgelegt ist. Sie können diese API-Parameter mit dem Flag overrideändern.

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

Im Folgenden finden Sie einige Beispiele für die Verwendung von Overrides.

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

Sie können auch mehrere Overrides für verschiedene Ressourcen kombinieren.

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

Um herauszufinden, welche Ressourcen und Parameter Sie ändern können, überprüfen Sie die relevanten Auslöser im GitHub-Repository der Stripe CLI.

Erweiterte Anpassung von Ereignissen

Wenn die verfügbaren Ereignisse oder Überschreibungen für Ihren Anwendungsfall nicht ausreichen, können Sie eine JSON-Datei schreiben, in der beschrieben wird, wie ein Ereignis generiert wird, und die CLI verwenden, um dieses Ereignis auszulösen. Lesen Sie die API-Dokumentation, um mehr zu erfahren.