Aller au contenu
Sections de la documentation

Events de webhook

Un endpoint de webhook Safecube ne reçoit que les types d'events auxquels il est abonné, définis dans le champ filterTypes de l'endpoint. Les events se répartissent en deux groupes : les events opérationnels, qui suivent le cycle de vie d'une expédition entière, et les alertes levées sur des jalons précis des conteneurs et des navires. Le catalogue d'events Svix de Safecube donne le schéma et un exemple de payload de chaque event.

Events opérationnels

Les events opérationnels suffisent à eux seuls pour utiliser la Webhooks API comme une API push. Chacun est envoyé une fois par expédition, pas une fois par conteneur, et son payload contient les informations de toute l'expédition.

Type d'eventDéclencheurEnvoi
shipment.added.to.endpointSafecube a reçu les premières données de suivi de l'expédition.Envoyé une fois, peu après l'ajout de l'expédition.
shipment.in.errorSafecube n'a reçu aucune donnée pour l'expédition, et l'expédition a été ajoutée il y a plus de 24 heures.Envoyé une fois par expédition, peu après l'ajout de l'expédition. Le payload contient l'erreur détectée.
shipment.any.changeUn ou plusieurs événements de l'expédition ont changé depuis la dernière mise à jour.Envoyé une fois pour tous les conteneurs de l'expédition, à chaque changement détecté.
shipment.auto.removedL'expédition a été retirée automatiquement des expéditions suivies : elle a été livrée il y a plus de 7 jours, ou un nouveau voyage a commencé avec le même conteneur.Envoyé une fois, au moment du retrait. Le payload contient la raison du retrait.
shipment.refresh.status.changeLa capacité de Safecube à rafraîchir les données de l'expédition a changé : le dernier statut de rafraîchissement, comme OK, en maintenance ou plus de crédits, diffère du précédent.Envoyé une fois pour tous les conteneurs de l'expédition, et plus jamais tant que le statut de rafraîchissement ne change pas de nouveau. Le payload contient le statut de rafraîchissement actuel et le précédent.
shipment.warning.split_blLe connaissement est peut-être scindé : au sein du même connaissement, les événements diffèrent d'un conteneur à l'autre.Envoyé une fois pour tous les conteneurs de l'expédition, et plus jamais sauf si les événements convergent puis divergent de nouveau.

La page Ajouter des expéditions explique comment réagir à shipment.added.to.endpoint et à shipment.in.error, et la page Règle de retrait automatique détaille quand une expédition est retirée automatiquement.

Alertes sur les événements réalisés

Ces alertes sont envoyées quand l'événement devient réalisé : son champ isActual passe à true. Les codes de statut et d'événement sont ceux de la Container Tracking API, listés sur la page Codes de statut et d'event.

Type d'eventStatutCode d'événementType de lieu
container.arrival.at.pre.pol—ARRIpré-POL
container.departure.from.pre.pol—DEPApré-POL
container.loaded.at.pre.pol—LOADpré-POL
container.arrival.at.first.polCGIGTINPOL
container.loaded.at.first.polCLLLOADPOL
vessel.departure.from.first.polVDLDEPAPOL
vessel.arrival.at.transhipment_portVATARRItransbordement
container.discharge.at.transhipment_portCDTDISCtransbordement
container.loaded.at.transhipment_portCLTLOADtransbordement
vessel.departure.from.transhipment_portVDTDEPAtransbordement
vessel.arrival.at.final.podVADARRIPOD
container.discharge.at.final.podCDDDISCPOD
container.departure.from.final.podCGOGTOTPOD
container.arrival.at.post.pod—ARRIpost-POD
container.discharge.at.post.pod—DISCpost-POD
container.departure.from.post.pod—DEPApost-POD

Alertes sur les changements de date

Ces alertes sont envoyées quand la date de l'événement change de plus de 24 heures, plus tôt ou plus tard, depuis la précédente alerte envoyée pour cet événement.

Type d'eventStatutCode d'événementType de lieu
date.changed.container.arrival.at.pre.pol—ARRIpré-POL
date.changed.container.departure.from.pre.pol—DEPApré-POL
date.changed.container.loaded.at.pre.pol—LOADpré-POL
date.changed.container.arrival.at.first.polCGIGTINPOL
date.changed.container.loaded.at.first.polCLLLOADPOL
date.changed.vessel.departure.from.first.polVDLDEPAPOL
date.changed.vessel.arrival.at.transhipment_portVATARRItransbordement
date.changed.container.discharge.at.transhipment_portCDTDISCtransbordement
date.changed.container.loaded.at.transhipment_portCLTLOADtransbordement
date.changed.vessel.departure.from.transhipment_portVDTDEPAtransbordement
date.changed.vessel.arrival.at.final.podVADARRIPOD
date.changed.container.discharge.at.final.podCDDDISCPOD
date.changed.container.departure.from.final.podCGOGTOTPOD
date.changed.container.arrival.at.post.pod—ARRIpost-POD
date.changed.container.discharge.at.post.pod—DISCpost-POD
date.changed.container.departure.from.post.pod—DEPApost-POD

Alerte de nouvel événement

container.new.event.detected est envoyé quand un nouvel événement est détecté pour un conteneur. Un événement est identifié par la combinaison de son statut, de son code d'événement et du code UN/LOCODE de son lieu (location.unlocode).