Webhook Integration Documentation

version: 1.1.0

Last updated: 2025-07-15

DeltaX supports client integration via webhooks. The general integration procedure follows these steps:

DeltaX sets up a new client in the platform and shares the credentials to the client.

The client implements a reception callback service according to the specification.

The client registers the webhook using the API.

Once registered, DeltaX automatically sends data updates to the callback service

1. Authentication

Once DeltaX has setup the client in the platform, the credentials sent to the client are:

Client Code: Short code uniquely identifying the client within the platform.

Authentication Token(s): Tokens used as authentication on API requests.

1.1 Usage

To use an authentication token on HTTP requests to the DeltaX API, the token has to be provided as a Bearer Token in the Authorization header.

2. Callback Registration

Method: GET
Path: /registerCallback
Query string parameters:

webhook (mandatory) - Code of webhook being registered (supported values: trips).

name (optional) - Describing name for the callback.

url (mandatory) - URL of the callback service.

callbackToken (optional) - Token that should be used by DeltaX in the update requests, not to be confused with the client authentication token. If provided, the update requests will include this token in the Authorization header. If not provided, the requests will be made without authentication.

distanceBetweenCallbacksMins (optional, default: 5) Time between update requests in minutes. For example, if the value is 5, one update request will be made to the callback service every 5 minutes. The minimum possible value is established per client.

maxDocumentsPerCallback (optional, default: 100) Maximum number of documents included in a single update request to the callback service. For example, if the value is 100, each update request will include at most 100 documents. If there are more documents needed to be updated, these will be included in further update requests. The maximum possible value is established per client.

3. Callback Service Specification

The callback service implemented by the client must be capable of receiving update requests from DeltaX. Each update request may include several documents.

Availability

The callback service must be publicly accessible via HTTPS. The IP used by DeltaX to make the update requests is not a dedicated, fixed IP and may change over time.

Authentication

The update requests made by DeltaX to the callback service are unauthenticated by default. However, if the callbackToken is set for the callback registration, the specified token is used as a bearer token in the Authorization header of the requests.

Request Format

The requests made by DeltaX to the callback service will have the following format:

Method: POST
URL: The url provided at registration.
Body: JSON with the following fields:

dateTime - Time of the request as marked by DeltaX.

webhook - Code of the webhook.

clientCode - Code of the client.

registrationCode - Code of the callback registration.

numDocuments - Number of documents being included in the request.

sizeBytes - Size of the documents (as JSON plain text) in bytes.

data - Array of documents. The format of each document depends on the webhook used.

Example:

Response

If the request is handled successfully then a 200 response status code is expected.
Any other response code (or lack thereof) is interpreted as a reception error and the service will attempt to send the documents on the next scheduled callback requests.

4. Document Format

4.1 Trips

Trip Fields:

TKNUM (String) - SAP Transport Number

F_ELIM (String) - Fields for Octopus traceability

ERDAT (Datetime) - SAP Creation date (UTC)

ERZET (Datetime) - SAP Creation time (UTC)

SIGNI (String) - SAP Round-trip or triangulation trip number

SHTYP (String) - SAP Transport Class ID

AEDAT (String) - SAP Last modified date

AEZET (String) - SAP Last modified time

ROUTE (String) - SAP Route ID

BEZEI_R (String) - SAP Route Description

KNOTA (String) - i2 Origin Location ID

KNOTZ (String) - i2 Destination Location ID

WERKS_O (String) - SAP Origin Plant ID

WERKS_D (String) - SAP Destination Plant ID

VSART (String) - SAP Shipping Class ID

BEZEI_V (String) - SAP Shipping Class Description

TDLNR (String) - SAP Carrier ID

NAME_TRANS (String) - SAP Carrier Description

ADD01 (String) - Supplement 1 ID Folio Type: Outbound = Null, Return = ZE00, Cancellation = ZC00

BEZEI_S1 (String) - SAP Supplement 1 Description Folio Type

ADD03 (String) - Supplement 3 ID Operation Type: Beer = TP04, Glass = TP09, Export = TP11, Self-service = TP01

BEZEI_S3 (String) - SAP Supplement Description 3 (OperationType)

DPREG (String) - SAP Load Appointment Date

UPREG (String) - SAP Load Appointment Time (UTC)

DPTEN (String) - SAP Unload Appointment Date

UPTEN (String) - SAP Unload Appointment Time (UTC)

TEXT1 (String) - Text 1

TEXT2 (String) - Text 2

TEXT3 (String) - Text 3

TEXT4 (String) - Text 4

plannedPlate (String) - TMS Planned Plate

planDate (String) - TMS Plan Date

priority (String) - TMS Priority

additional (String) - TMS Additional

ADD02 (String) - Supplement ID 2

ADD04 (String) - Supplement ID 4

SDABW (String) - Special Management Indicator ID

TPLST (String) - Transport Planning Position ID

VSBED (String) - Shipping Condition ID

EXTI1 (String) - Ext ID 1

TNDR_TRKID (String) - Tracking ID

LFIMG_P (Int32) - Planned Pallets

WBSTK_S (String) - Goods Outbound Movement (VL02N)

WBSTK_E (String) - Goods Inbound Movement (VL06I)

SGE_S (String) - Global Delivery Status (Outbound)

SGE_E (String) - Global Delivery Status (Inbound)

STTRG (String) - Global Transportation Status

DDTEXT (String) - Global Transportation Status Description

DTDIS (String) - Needed Planning Date (Execution)

UZDIS (String) - Needed Planning Time (Execution)

DAREG (String) - Recording Date (Execution)

UAREG (String) - Recording Time (Execution)

DALBG (String) - Loading Start Date (Execution)

UALBG (String) - Loading Start Time (Execution)

DALEN (String) - Loading End Date (Execution)

UALEN (String) - Loading End Time (Execution)

DTABF (String) - Export Dispatch Date (Execution)

UZABF (String) - Export Dispatch Time (Execution)

DATBG (String) - Transportation Start Date (Execution)

UATBG (String) - Transportation Start Time (Execution)

DATEN (String) - Transportation End Date (Execution)

UATEN (String) - Transportation End Time (Execution)

Entregas (Array) - Array of delivery wares

transportCompanyName (String) - DeltaX Transport Company

truckPlate (String) - Plate of truck

truckEconomicNumber (String) - Economic number of truck

trailerPlate (String) - Plate of first trailer

trailerEconomicNumber (String) - Economic number of first trailer

secondTrailerPlate (String) - Plate of second trailer

secondTrailerEconomicNumber (String) - Economic number of second trailer

truckerName (String) - Name of trucker

truckerLicenseNumber (String) License number of trucker

assignmentDate - (Datetime) Date of loading order assignment to transport company

originEtaDate - (Datetime) Origin ETA Date

originEtaStatus - (String) Origin ETA Status: advanced = Arrived before ETA, onSchedule = Arrived at ETA, delayed = Arrived - after ETA, completed = ETA Completed

originAtaDate - (Datetime) Origin ATA Date

originAtaStatus - (String) Origin ATA Status: advanced = Arrived before ETA, onSchedule = Arrived at ETA, delayed = Arrived - after ETA, completed = ETA Completed

originExternalEntryDate - (Datetime) Date of origin external geofence entry

originInternalEntryDate - (Datetime) Date origin internal geofence entry

originInternalLeftDate - (Datetime) Date origin internal geofence departure

originExternalLeftDate - (Datetime) Date origin external geofence departure

destinationEtaDate - (Datetime) Destination ETA Date

destinationEtaStatus - (String) Destination ETA Status: advanced = Arrived before ETA, onSchedule = Arrived at ETA, delayed = Arrived - after ETA, completed = ETA Completed

destinationAtaDate - (Datetime) Destination ATA Date

destinationAtaStatus - (String) Destination ATA Status: advanced = Arrived before ETA, onSchedule = Arrived at ETA, delayed - = Arrived after ETA, completed = ETA Completed

destinationExternalEntryDate - (Datetime) Date of destination external geofence entry

destinationInternalEntryDate - (Datetime) Date of destination internal geofence entry

destinationInternalLeftDate - (Datetime) Date of destination internal geofence departure

destinationExternalLeftDate - (Datetime) Date of destination external geofence departure

tripStatus - (String) Status of trip: scheduled = Scheduled, confirmed = Confirmed, adjustment = Adjustment, rejected = Rejected, assigned = Assigned, originOnRoute = On route to origin, - originExternalEntry = Arrival at origin, originInternalEntry = Entered origin, originInternalLeft = Left origin, - destinationOnRoute = On route to destination, destinationExternalEntry = Arrival at destination, destinationInternalEntry = - Entered destination, completed = Completed, completedHibrid = Hybrid completed, completedImport = Manually completed, - finished = Finished, cancelled = Cancelled

operationStatus - (String) Status of operation: pending = Pending, postponed = Postponed, loading = Loading, expired = Expired, atRisk = At Risk, underway = Underway, unloadPending = Unload Pending, unloading = Unloading, accountingPending = Account Pending, returning = Returning, delivered = Delivered, cancelled = Cancelled

url - (String) URL to the detail page of the trip.

incidences (Array) - Array of incidences

Delivery Ware Fields:

TKNUM_V (String) - Request Number

VBELN (String) - Delivery Number

POSNR (String) - Delivery Item

MATNR (String) - SKU (Material)

ARKTX (String) - Material Description

WERKS (String) - SAP Plant ID Delivery Destination

LGORT (String) - Warehouse ID Delivery Destination

LFIMG (Int32) - Quantity

MEINS (String) - Unit of Measure Quantity

VGBEL (String) - Order

BRGEW (Decimal) - Gross Weight

GEWEI (String) - Unit of Measure Gross Weight

NTGEW (Decimal) - Net Weight

GEWEI_NET (String) - Unit of Measure Net Weight

VOLUM (Decimal) - Volume

VOLEH (String) - Unit of Measure Volume

ANZPK (String) - Total Pallets Quantified

WADAT_IST (String) - Output Date

LFART_ES (String) - Output/Input Posting Indicator

FCONT_SAL (String) - Inventory Output Posting Date and Time

FCONT_ENT (String) - Inventory Input Posting Date and Time

Incidence fields:

stage (String) - Stage at which the incidence occurred.

incident (String) - Code of the incidence

offender (String) - Offender of the incidence

observation (String) - Code of the observation

comment (String) - Comment for the incidence

Example:

Webhook Integration Documentation

Webhook Integration Documentation#

version: 1.1.0#

Last updated: 2025-07-15#

1. Authentication#

1.1 Usage#

2. Callback Registration#

3. Callback Service Specification#

Availability#

Authentication#

Request Format#

Response#

4. Document Format#

4.1 Trips#

Webhook Integration Documentation

version: 1.1.0

Last updated: 2025-07-15

1. Authentication

1.1 Usage

2. Callback Registration

3. Callback Service Specification

Availability

Authentication

Request Format

Response

4. Document Format

4.1 Trips