Aller au contenu
Sections de la documentation

Utiliser les webhooks comme une API push

La Webhooks API de Safecube a deux usages : prévenir vos utilisateurs de changements précis dans les données de suivi, et mettre à jour vos données automatiquement sans aucune requête à la Container Tracking API. Utilisée de la seconde façon, c'est une API push de suivi de conteneurs. La page Suivi synchrone et asynchrone compare les deux approches.

Étapes d'une intégration push

Utiliser la Webhooks API comme une API push se fait en cinq étapes :

  1. Définissez comment recevoir les données : créez un endpoint.
  2. Transmettez le détail des expéditions au système de suivi de Safecube : ajoutez des expéditions à l'endpoint.
  3. Recevez les données de suivi initiales de chaque expédition.
  4. Recevez une mise à jour chaque fois que Safecube a de nouvelles données pour une expédition.
  5. Si vous le souhaitez, recevez une alerte quand une expédition transmise ne peut pas être suivie.

La page Premiers pas avec les webhooks montre comment créer un endpoint et transmettre vos premières expéditions.

Events recommandés pour le suivi en push

Abonnez l'endpoint à ces events :

BesoinEvent
Recevoir les données de suivi initiales d'une expéditionshipment.added.to.endpoint
Recevoir une mise à jour dès que de nouvelles données existentshipment.any.change
Être alerté quand une expédition transmise ne peut pas être suivieshipment.in.error et shipment.auto.removed

La page Events de webhook décrit le déclencheur et le payload de chaque event.

Events ciblés en complément du suivi en push

Utiliser la Webhooks API comme une API push n'empêche pas des notifications plus ciblées. S'abonner à des events fins vous dit tout de suite ce qui a changé, par le type d'event lui-même.

Par exemple, date.changed.vessel.arrival.at.final.pod notifie chaque changement de l'heure d'arrivée estimée au POD, tandis que shipment.any.change vous tient informé de toutes les autres mises à jour.