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
headerspour transmettre un secret partagé (par exemple un token dans l’en-têteAuthorization) 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.