Mise en place
Les webhooks préviennent votre serveur quand des données changent dans notre système Wino, avec une requête HTTP POST vers une URL de votre choix. Utilisez-les pour garder un autre système synchronisé, une boutique en ligne par exemple, sans interroger sans cesse notre Open API.
Comment ça fonctionne
- Vous vous abonnez avec l'API REST ci-dessous : chaque abonnement suit une boutique et envoie vers une URL.
- À chaque changement dans cette boutique (un produit est modifié …), Wino envoie une notification à votre URL.
- Votre serveur les traite et répond rapidement.
L'API des abonnements
- L'API se trouve à
{{baseUrl}}/webhooks/subscriptions(voir Environnements). - Chaque requête nécessite votre clé d'API (voir Authentification).
| Méthode | Chemin | Action |
|---|---|---|
GET | /webhooks/subscriptions | Lister vos abonnements |
GET | /webhooks/subscriptions/{id} | Récupérer un abonnement |
POST | /webhooks/subscriptions | Créer un abonnement |
PATCH | /webhooks/subscriptions/{id} | Modifier certaines de ses propriétés |
PUT | /webhooks/subscriptions/{id} | Le remplacer (ses réglages d'événements reviennent aux valeurs par défaut) |
DELETE | /webhooks/subscriptions/{id} | Le supprimer |
Un abonnement créé, modifié ou supprimé met jusqu'à 5 minutes à s'appliquer : après un DELETE ou disabled: true, des notifications peuvent encore arriver pendant 5 minutes. C'est pourquoi PATCH répond avec une propriété warning.
Entités qui publient des changements :
Chaque abonnement a des settings : pour chaque type de données, si vous êtes notifié ou non. Un nouvel abonnement suit les quatre premiers types. Pour en activer d'autres, envoyez un PATCH avec leurs settings après l'avoir créé (voir Gérer les abonnements).
| Type | Activé par défaut |
|---|---|
Product | oui |
Variant | oui |
VariantPrice | oui |
StockActivity | oui |
Shop | non |
Device | non |
Tax | non |
Price | non |
Category | non |
Customer | non |
Voucher | non |
Reward | non |
LoyaltyActivity | non |
Staff | non |
Quote | non |
DeliveryNote | non |
CreditNote | non |
Invoice | non |
RefundReceipt | non |
SalesReceipt | non |
CashFlow | non |
CashRegisterReport | non |
Supplier | non |
Order | non |
- Un mouvement de stock envoie une notification
StockActivity, pasVariant: suivezStockActivitypour suivre le stock. - Les prix définis avec
createOrUpdateVariantPrice, et les catégories créées ou modifiées via l'API, n'envoient pas de notification. archiveVariant,unarchiveVariant,activateVariantetdeactivateVariantn'envoient pas non plus de notification, pas plus que l'archivage et le désarchivage du produit quearchiveVariantetunarchiveVarianteffectuent sur son produit (quand il archive la dernière variante non archivée du produit, ou désarchive une variante d'un produit archivé).- Un mouvement
DELIVERYouRECEPTIONsur une variante inactive la rend active, sans notificationVariant: relisez le champactivede la variante quand vous recevez sonStockActivity. - Les commandes fournisseur traitées dans l'application Wino peuvent rendre une variante active et changer son fournisseur et son prix d'achat, sans notification
Variant. Relisez les variantes quand vous recevez la notificationOrderouStockActivity.