Déclencher des événements de webhook avec l'interface de ligne de commande Stripe

Découvrez comment déclencher des événements de webhook dans un environnement de test.

Il existe deux façons de déclencher des événements de webhook dans un environnement de test :

Effectuez les actions qui conduisent à l’événement que vous souhaitez déclencher. Par exemple, la création d’un client avec l’API Stripe ou dans le Dashboard Stripe génère un événement customer.created.
Exécutez une commande avec l’interface de ligne de commande Stripe pour générer automatiquement l’événement.

Déclencher des événements

Pour voir le nom de tous les événements pris en charge par la Stripe CLI, exécutez cette commande :

Command Line
stripe trigger --help

Pour déclencher un événement spécifique, exécutez la commande suivante en remplaçant <EVENT> par le nom de l’événement :

Command Line
stripe trigger <EVENT>

Par exemple, cette commande déclenche l’événement payment_intent.succeeded :

Command Line
stripe trigger payment_intent.succeeded

Ensuite, vous pouvez afficher l’événement dans la page Événements du Dashboard ou en utilisant la commande stripe listen.

Remarque

Selon l’événement que vous déclenchez, la Stripe CLI peut générer plusieurs événements connexes. Par exemple, lors de l’exécution de stripe trigger price.created, la Stripe CLI doit créer un produit pour créer un prix, elle génère donc deux événements : product.created et price.created.

Personnaliser les événements

Pour générer des événements, la Stripe CLI appelle l’API Stripe avec certains paramètres prédéfinis. Par exemple, pour déclencher l’événement payment_intent.succeeded, la Stripe CLI appelle l’endpoint de création de PaymentIntent, avec le paramètre amount défini sur 2000. Vous pouvez modifier ces paramètres d’API avec l’option override.

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

Voici des exemples de remplacement :

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

Vous pouvez également combiner plusieurs remplacements sur différentes ressources.

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

Pour savoir quelles ressources et quels paramètres vous pouvez modifier, examinez les déclencheurs pertinents dans le répertoire GitHub de l’interface de ligne de commande Stripe.

Personnalisation avancée des événements

Si les événements ou les remplacements disponibles ne suffisent pas à votre cas d’usage, vous pouvez écrire un fichier JSON décrivant comment générer un événement, et utiliser la CLI pour déclencher cet événement. Pour en savoir plus, consultez la page Créer et utiliser des fixtures.