Version de travail · contenus et exemples à affiner Voir les 95 pages ↗
Parlons de votre projet ↗
Webhooks / P042

Introduction aux Webhooks

Adaptation éditoriale
Référence de travail. Les routes, schémas, limites et procédures hérités du référentiel sont à aligner avec l’API d’Éric. Ils ne prouvent pas une fonctionnalité livrée. Les hôtes .invalid sont des exemples inertes.

Kelyko appelle votre endpoint en POST dès qu'un événement le concerne. Vous n'avez pas à interroger l'API en boucle, ce qui vous ferait de toute façon atteindre la limite de 500 requêtes par minute.

Chaque appel est le même, quel que soit l'événement :

  • Kelyko-Signature : HMAC-SHA256 du corps brut, en hexadécimal
  • Kelyko-Event : le nom de l'événement. C'est ce champ qui décide comment lire le corps
  • Kelyko-Webhook-Version : la version du format de livraison

Le corps change selon Kelyko-Event. La liste, les exemples et qui les reçoit sont dans Événements. Un paiement qui échoue n'envoie pas TRANSACTION_COMPLETED. Un paiement retenu en escrow envoie ESCROW_HELD à sa place, puis TRANSACTION_COMPLETED à sa libération.

La livraison est réessayée jusqu'à trois fois si votre serveur ne répond pas. Voir Comportement.

Trois abonnements

Abonnement Où le créer Ce qu'il couvre
Entreprise Dashboard, une URL pour le compte Chaque événement routé vers l'entreprise, tous magasins confondus
Magasin Dashboard, une URL par magasin Les événements dont l'expéditeur vise ce magasin
plateforme POST /partner_api/service_providers/business_webhook_subscriptions Les événements visés sur le magasin dédié de ce marchand

Un abonnement magasin n'est pas limité à TRANSACTION_COMPLETED. Il reçoit un événement lorsque l'expéditeur passe son storeId. Le magasin dédié d'un plateforme reçoit donc aussi les rattachements, l'escrow et la conformité, si events est null ou les liste. Le détail est dans Événements.

La création côté plateforme est dans Webhooks marchand. La configuration Dashboard est dans Intégration.

De l'événement au traitement

  1. Configuration : une URL HTTPS, au Dashboard ou via l'API plateforme
  2. Événement : une transaction, un rattachement, un escrow ou une vérification
  3. Notification : Kelyko POSTe le corps, avec Kelyko-Event
  4. Vérification : vous vérifiez Kelyko-Signature sur le corps brut
  5. Traitement : vous branchez sur Kelyko-Event
  6. Réponse : HTTP 200 pour accuser réception

Et ensuite

  1. Événements : chaque Kelyko-Event et son corps
  2. Intégration : URL, secret, signature
  3. Comportement des webhooks : retries et délai
  4. Bonnes pratiques : sécurité, idempotence et monitoring
  5. Exemples de code : implémentations