Skip to content

Webhook for locker updates
Webhook

Request

Webhook to push locker updates to any URL provided by the carrier. This endpoint allows carriers to receive real-time updates about lockers.

Security
ApiKeyAuth
Bodyapplication/json

Information about locker updates.

uidstring

The internal unique identifier assigned to the locker.

Example:"1002377838"
carrierobject(carrier)

The details of the locker on the Carrier's system.

providerobject(provider)

The details of the locker on the Provider's system.

locationobject(location)

Details about the geographical location of the locker.

featuresobject(features)

Features available in the locker.

openingHoursobject(opening_hours)

Locker availability schedule.

Conditional constraints (enforced server-side, not by the generated client):

  • If accessMode is SCHEDULED, weeklySchedule MUST be provided and non-empty.
  • If accessMode is ALWAYS, weeklySchedule MUST be omitted.
metadataArray of objects(metadata)

Additional metadata associated with the locker.

ownedByCarrierstring or null

Indicates which carrier owns the locker. null means the locker belongs to a 3rd party provider.

Example:"GLS"
compartmentTypesArray of objects or null(compartment)

A list of different compartment types available in the locker.

Example:
[
  {
    "size": "SMALL",
    "count": 10,
    "height": 200,
    "width": 400,
    "length": 600
  },
  {
    "size": "MEDIUM",
    "count": 4,
    "height": 400,
    "width": 400,
    "length": 600
  },
  {
    "size": "LARGE",
    "count": 2,
    "height": 800,
    "width": 400,
    "length": 600
  }
]
eventTimestampstring, (date-time)required

The timestamp of the locker status update.

Example:"2025-08-20T00:00:00Z"
Payload
{
  "uid": "1002377838",
  "carrier": {
    "lockerName": "Berlin Locker 01",
    "lockerId": "XR1003",
    "activationDate": "2025-08-20T00:00:00Z",
    "status": "ACTIVE"
  },
  "provider": {
    "name": "KEBA",
    "lockerModel": "Model 1",
    "lockerVersion": "v2.1",
    "lockerName": "BLOQ-Berlin-12045-001",
    "lockerUid": "PROVIDER_LOCKER_ABC123",
    "status": "ACTIVE"
  },
  "location": {
    "street": "Main Street",
    "streetNumber": "1",
    "postalCode": "90210",
    "city": "Berlin",
    "lon": -118.2437,
    "lat": 34.0522,
    "countryCode": "DE",
    "type": "indoor"
  },
  "features": {
    "hasScreen": true,
    "hasPinPad": true,
    "hasPinBarcodeReader": false
  },
  "openingHours": {
    "accessMode": "ALWAYS",
    "weeklySchedule": [ … ],
    "exceptions": [ … ]
  },
  "metadata": [
    { … }
  ],
  "ownedByCarrier": "GLS",
  "compartmentTypes": [
    { … },
    { … },
    { … }
  ],
  "eventTimestamp": "2025-08-20T00:00:00Z"
}

Responses

Return a 200 status to indicate that the data was received successfully.