Jèko
Webhooks

Introduction aux Webhooks

Une seule livraison, trois en-têtes, et trois façons de s'abonner

Vue d'ensemble

Jèko 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 :

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

Le corps change selon Jeko-Event. La liste, les exemples et qui les reçoit sont dans Événements. Un paiement qui échoue n'envoie pas TRANSACTION_COMPLETED.

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

Trois abonnements

AbonnementOù le créerCe qu'il couvre
EntrepriseDashboard, une URL pour le compteChaque événement routé vers l'entreprise, tous magasins confondus
MagasinDashboard, une URL par magasinLes événements dont l'expéditeur vise ce magasin
Service ProviderLes é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 Service Provider 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é Service Provider est dans Webhooks marchand. La configuration Dashboard est dans Intégration.

Flux

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

Étapes suivantes

  1. Événements : chaque Jeko-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

On this page