Webhooks

Webhook payloads

All property names are case-sensitive and use the envelope described in Webhook overview. Data has one of the following shapes.

Business-partner unloading-point opening hours

Data contains BusinessPartner, UnloadingPoint, and OpeningHours.

• BusinessPartner: Id, ReferenceNumber.
• UnloadingPoint: Id, ReferenceNumber, Name.
• OpeningHours: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, ClosedDays.
• Each day: IsOpen, IsOpenAllDay, Hours; each interval has From and To.
• Each closed-day entry: Type, From, and optional To.

Lane webhooks

SendLaneOnDemand, LaneCreation, LaneTenderAssignment, and LaneTenderPublished share the same Data structure: Lane, LogisticRequirements, and optional Tender.

Lane contains:

Id, CompanyFromName, CompanyFromReferenceNumber, ProductName, ProductReferenceNumber, ProductType, ProductAdrClass, ProductAdrPackingGroup, ProductTransportTemperature, ProductTemperatureControlledTransportEquipment, SiteFromName, SiteFromReferenceNumber, SiteFromCity, SiteFromZipCode, SiteFromCountry, SiteFromCountryCode, LoadingPointName, LoadingPointReferenceNumber, CompanyToName, CompanyToReferenceNumber, SiteToName, SiteToReferenceNumber, SiteToCity, SiteToZipCode, SiteToCountry, SiteToCountryCode, UnloadingPointName, UnloadingPointReferenceNumber, UnloadedProductName, UnloadedProductReferenceNumber, UnloadedProductType, UnloadedProductAdrClass, UnloadedProductAdrPackingGroup, UnloadedProductTransportTemperature, and UnloadedProductTemperatureControlledTransportEquipment.

The Product… fields describe the outbound product and the UnloadedProduct… fields the inbound product.

LogisticRequirements contains LoadingRequirements and UnloadingRequirements. Loading requirements contain:

ProductFromRequiredCleaningProcedure, ProductFromCertificateOfPreviousCargo, ProductFromVacuumTestConfirmation, ProductFromVehicleTypeRequired, ProductFromVehicleSpecialEquipment, ProductFromChassis, ProductFromEquipmentOperated, ProductFromNumberOfCompartments, ProductFromDipTube, ProductFromHeatedDipTube, ProductFromNitrogenInerting, ProductFromCoupling, ProductFromCouplingType, ProductFromCouplingSize, ProductFromCouplingConfiguration, ProductFromFlange, ProductFromFlangeType, ProductFromFlangeSize, ProductFromHeatingSystemConnection, ProductFromCompressorToBeProvidedByCarrier, ProductFromConnectionToBeProvidedByCarrier, ProductFromVapourReturnCoupling, ProductFromHeatingDuringTransport, ProductFromHeatingSettingsDuringTransport, ProductFromHeatingType, ProductFromCarrierMustBeCertifiedAccordingTo, and ProductFromReactorLoading.

Unloading requirements contain:

ProductToRequiredCleaningProcedure, ProductToVehicleTypeRequired, ProductToVehicleSpecialEquipment, ProductToChassis, ProductToEquipmentOperated, ProductToNumberOfCompartments, ProductToCoupling, ProductToCouplingType, ProductToCouplingSize, ProductToCouplingConfiguration, ProductToFlange, ProductToFlangeType, ProductToFlangeSize, ProductToHoseSpecificationLength, ProductToPumpToBeProvidedByCarrier, ProductToCompressorToBeProvidedByCarrier, ProductToConnectionToBeProvidedByCarrier, ProductToVapourReturnCoupling, ProductToHeatingDuringTransport, ProductToUnloadingTemperature, and ProductToSpecialCertification.

Temperature fields (ProductTransportTemperature, UnloadedProductTransportTemperature, ProductFromHeatingSettingsDuringTransport, and ProductToUnloadingTemperature) are text with every configured period, including unit and date range, separated by , , for example Minimum 5 °C Maximum 25 °C from 1 January to 31 March, Minimum 10 °C Maximum 30 °C from 1 April to 31 December. The temperature controlled transport equipment fields contain Required, followed by the date range when one is set, and are empty when it is not required.

When present, Tender contains TenderId, TenderName, TenderReferenceNumber, TenderStatus, and LaneId.

Loading- and unloading-point yard updates

Data contains CompanyId, SiteReferenceNumber, ReferenceNumber, Name, BuildingName, IsWarehouse, OpeningHours, DriveInTimeRestrictions, Processes, and UpdatedTimeUtc.

OpeningHours uses the same weekday structure described above. DriveInTimeRestrictions contains EarliestDriveInBeforeOpeningMinutes, LatestDriveInBeforeClosingMinutes, EarliestDriveInBeforePlannedSlotMinutes, and LatestDriveInBeforePlannedSlotMinutes. Each process has Id and AdditionalInformation.

Assigned-product yard updates

Data contains CompanyId, SiteReferenceNumber, UnloadingLoadingPointReferenceNumber, ProductName, ReferenceNumber, Processes, and UpdatedTimeUtc. The point reference can identify a loading or unloading point; the configured webhook scope and event context determine which.