Dit is de volledige catalogus. Wat hier niet staat, kan Cargofollow niet vastleggen en niet
afleveren: dezelfde lijst voedt de hash-keten, de filters op je webhook-endpoint en het
OpenAPI-document. Abonneer een endpoint op losse namen, op een familie-wildcard (shipment.*) of
op *.
Elke levering heeft dezelfde buitenkant. Het type bepaalt wat er in data zit; mode zegt of
de gebeurtenis uit de sandbox of uit live komt, zodat één ontvanger beide aankan.
Er is een zending aangemaakt, als concept of meteen uitgegeven. De zending heeft een shp_-id en een eerste versie, maar staat nog niet vast.
shipment.issued
De vrachtbrief is uitgegeven. Partijen, goederen en adressen liggen vanaf nu vast, de eerste PDF staat klaar en de zending is klaar om te tekenen.
shipment.updated
Een wijziging in de muteerbare velden heeft een nieuwe versie gemaakt. changed_paths zegt precies welke velden veranderden, zodat je gericht kunt bijwerken.
shipment.cancelled
De zending is geannuleerd. Er volgen geen handtekeningen of afleveringen meer; de keten blijft wel verifieerbaar.
shipment.pickup_signed
De vervoerder heeft bij de laadplaats getekend. De zending is onderweg — het moment om je eigen transportstatus op in_transit te zetten.
shipment.delivered
De geadresseerde heeft bij aflevering getekend. De ePOD is beschikbaar; has_remarks zegt of er een voorbehoud bij zit dat je moet laten beoordelen.
shipment.completed
De zending is administratief afgesloten: het afleverbewijs is geaccepteerd en er volgt niets meer. Dit is het moment om te factureren en het dossier te archiveren.
signature.completed
Er is een handtekening of zegel vastgelegd, voor welke rol dan ook. trust_level en method zeggen hoe zwaar die handtekening weegt in een geschil.
document.created
Er is een document opgeslagen: een PDF-versie, een bijlage, een foto of een handtekeningafbeelding. De sha256 hoort bij de bytes in de opslag.
remark.added
Er is een voorbehoud vastgelegd bij het laden of het lossen. Dit is het event waar een schadeproces op hoort te starten.
inspection.viewed
Iemand heeft de inspectielink geopend. Het IP zelf wordt nooit bewaard; ip_hash maakt herhaalbezoek herkenbaar zonder de bezoeker te identificeren.
provider.sync_failed
Synchroniseren met de eCMR-provider mislukte. will_retry zegt of Cargofollow het zelf nog een keer probeert, of dat er iets van jou nodig is.
efti.uil_issued
De eFTI Unique Identifier Link is uitgegeven. Dit is de verwijzing die een handhaver vanaf 9 juli 2027 kan opvragen.
efti.authority_access
Een bevoegde autoriteit heeft deze zending via een nationale eFTI-gate opgehaald. gate_id zegt welke gate, subsets op welke rechtsgrond; wie de handhaver is krijgt het platform niet te horen.
efti.combined_transport_stamped
Een spoor- of havenautoriteit heeft een afgelegd niet-wegtraject van dit gecombineerd vervoer afgestempeld (Richtlijn 92/106/EEG art. 3). De stempel maakt geen nieuwe versie: handtekeningen blijven staan.
ping
Testgebeurtenis vanuit de console of POST /v1/webhook-endpoints/{id}/test. Hangt niet aan een zending en komt dus nooit in een hash-keten.
Alle gebeurtenissen behalve ping horen bij een zending en vormen daar de hash-keten. ping
hoort bij een webhook-endpoint en komt dus nooit in een keten voor.
De velden hieronder staan in data. Een veld dat als optioneel staat aangemerkt kan ontbreken —
lees het nooit zonder controle. Nieuwe optionele velden mogen zonder aankondiging verschijnen, dus
negeer wat je niet kent in plaats van te falen.
De kolom “Betekenis” komt letterlijk uit de schema’s in @freightapi/core en staat daarom in het
Engels: het is exact dezelfde tekst als in het OpenAPI-document, zodat één woordenlijst
geldt voor de reference, de SDK’s en deze pagina.