Skip to main content
Ce guide explique comment enregistrer un webhook pour être notifié automatiquement des événements Paps, plutôt que d’interroger l’API en continu.

Enregistrer un webhook

POST /webhook

Authentification

Body

Champs

Réponse — 201

Le webhook est créé.

L’événement StatusUpdated

Un changement de statut de colis déclenche un appel POST vers l’URL configurée, avec les en-têtes définis dans headers.
Le champ message est actuellement rédigé en anglais. Voir Statuts de livraison pour la liste complète des valeurs de status et leur signification.
STATUS_UPDATED est le seul événement disponible actuellement. D’autres événements pourront être ajoutés par la suite.

Sécuriser l’URL de votre webhook

  • Exposez votre endpoint uniquement en HTTPS.
  • Utilisez le champ headers pour transmettre un secret partagé (par exemple un token dans l’en-tête Authorization) et vérifiez-le à la réception de chaque appel. C’est le mécanisme à utiliser pour authentifier les appels entrants.

Répondre rapidement avec un statut 2xx

Votre endpoint doit répondre le plus vite possible avec un code 2xx pour accuser réception de l’événement. Traitez le contenu de manière asynchrone (file d’attente, job en arrière-plan) plutôt que de bloquer la réponse.

Gérer les doublons

Concevez votre endpoint pour qu’il soit idempotent : un même événement reçu plusieurs fois ne doit pas produire d’effet différent. C’est une bonne pratique standard pour tout récepteur de webhook, quel que soit son fournisseur.

Journaliser les événements

Conservez une trace de chaque événement reçu (horodatage, payload brut, code de réponse renvoyé) pour faciliter le diagnostic en cas d’écart avec l’état observé côté Paps.