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, SiteFromName, SiteFromReferenceNumber, SiteFromCity, SiteFromZipCode, SiteFromCountry, SiteFromCountryCode, LoadingPointName, LoadingPointReferenceNumber, CompanyToName, CompanyToReferenceNumber, SiteToName, SiteToReferenceNumber, SiteToCity, SiteToZipCode, SiteToCountry, SiteToCountryCode, UnloadingPointName, UnloadingPointReferenceNumber, UnloadedProductName, UnloadedProductReferenceNumber, and UnloadedProductType.

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, 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, and ProductToSpecialCertification.

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.