🎯 Intention

Dans le cas de paiement, il est utile de mettre en place un webhook sur nos services afin d’être tenu au courant quand un paiement réussi, échoué, etc …

Le webhook doit enregistrer les paramètres reçu pour être traités dans un job en asynchrone et retourner obligatoirement une 200 (pas besoin d’attendre que le job soit traité)

<aside> ✅ Pré-requis

• Rails : Créer un job avec Sidekiq
• API: Faciliter l’utilisation d’une API grâce à une documentation OpenAPI (Swagger)
• ‣ </aside>

✅ Points clés

<aside> ⌛ Temps indicatif : 3h

</aside>

✍️ Faire le point d’api (Webhook)

💼 Faire le job webhook

🟢 Écrire la classe responsable de la logique du webhook

🔒 Sécuriser le webhook (facultatif)

❌ Erreurs type à éviter

• Coder l’ensemble de la fonctionnalité sans tester à partir de vrai donnée.

  Nous avons observé à plusieurs reprises que les développeurs attendent d'avoir terminé l'intégralité de leur fonctionnalité avant de déployer le code. Il est préférable de déployer d'abord la partie initiale (route + enregistrement des appels en base de données) pour analyser des cas d'usage réels, puis d'implémenter la logique métier dans une seconde Pull Request.

  Exemple de ticket avec l’erreur

🎓Aller plus loin

Travaux pratique 🎓