Events & Payloads

When an event triggers a webhook, Mobiledock sends an HTTP POST request to your configured URL with a JSON payload.

Event types

The types array in the payload indicates which events triggered this webhook. A single payload can contain multiple event types.

Event Type	Description
Created	A new booking was created
FlowStatusUpdate	The booking’s status changed through the normal flow
AssignedSpace	A space was assigned to the booking
RequestedTimeUpdate	The booking’s requested time was changed
TasksChange	The booking’s tasks were modified
VehicleChange	The booking’s vehicle was changed

Payload structure

Top-level properties

Property	Type	Description
eventTriggeredAt	string	ISO 8601 timestamp of the event
createdAt	string	When the booking was created
modifiedAt	string	When the booking was last modified
types	string[]	Event types that triggered this webhook
id	string	Booking code (e.g. MDB-24-8X4K-7G5J)
pin	string	Booking PIN
location	Organisation	The location organisation
carrier	Organisation	The carrier organisation
carrierCore	CoreDetails	Carrier’s Core ID details
area	Area	The booking area
space	Space	The assigned space
requestedTime	string	ISO 8601 requested booking time
bookedTime	string	ISO 8601 booked time
duration	number	Duration in minutes
vehicle	Vehicle	The vehicle
tasks	Task[]	Array of tasks on the booking
status	Status	Current booking status
bookingHistory	History[]	Booking history (if enabled)
fieldData	FieldData[]	Custom field values
driver	Driver	Driver information
bookingType	string	Booking type (e.g. Standard)
comments	Comment[]	Booking comments (if enabled)

Organisation object

Property	Type	Description
id	string	Organisation UUID
name	string	Organisation name
connectionAttributes	object	Key-value connection attributes
timezone	string	IANA timezone identifier
address	Address	Organisation address

Task object

Property	Type	Description
id	string	Task code
sender	Organisation	Sender organisation
senderCore	CoreDetails	Sender’s Core ID details
receiver	Organisation	Receiver organisation
receiverCore	CoreDetails	Receiver’s Core ID details
direction	string	Inbound or Outbound
loads	Load[]	Array of load quantities
bookingOptions	BookingOption[]	Booking options
document	Document	Associated document
documentId	string	Document ID

Core Details object

Property	Type	Description
ids	string[]	Array of Core IDs
name	string	Core name

Example payload

{
  "eventTriggeredAt": "2024-08-20T02:35:30Z",
  "createdAt": "2024-08-20T02:35:30Z",
  "modifiedAt": "2024-08-20T02:35:30Z",
  "types": ["FlowStatusUpdate", "Created", "AssignedSpace"],
  "id": "MDB-24-8X4K-7G5J",
  "pin": "10523",
  "location": {
    "id": "c875c903-7d98-4ee5-852e-2c8a7b435484",
    "name": "My Organisation",
    "timezone": "Australia/Melbourne",
    "address": {
      "address1": "123 Main St",
      "city": "Melbourne",
      "postal": "3000",
      "country": "Australia"
    }
  },
  "carrier": {
    "id": "c875c903-7d98-4ee5-852e-2c8a7b435484",
    "name": "My Organisation"
  },
  "area": {
    "id": "28177157-9615-49a0-8327-3d0fbb8g40c6",
    "name": "West Dock"
  },
  "space": {
    "id": "2187c155-cc57-4cca-8838-db72a4e98bb9",
    "name": "Bay 01"
  },
  "requestedTime": "2024-08-20T02:35:00Z",
  "bookedTime": "2024-08-20T02:35:00Z",
  "duration": 60,
  "vehicle": {
    "id": "b9ce5dcf-83f7-4548-8d38-ca2be7f073b0",
    "name": "Van"
  },
  "tasks": [
    {
      "id": "MDT-01-DP0Y-9F2L",
      "sender": {
        "id": "5br33d6r-2e40-4hdd-a5ac-628w44fef74f",
        "name": "Supplier 1"
      },
      "receiver": {
        "id": "c875c903-7d98-4ee5-852e-2c8a7b435484",
        "name": "My Organisation"
      },
      "receiverCore": {
        "ids": ["00000123"],
        "name": "Vendor #123"
      },
      "direction": "Inbound",
      "loads": [
        {
          "id": "99746ak5-417d-4f4p-9f74-1c74af80eb5d",
          "name": "Pallets",
          "quantity": 10,
          "loadTag": null
        }
      ],
      "document": {
        "id": "PO1234",
        "description": "",
        "attributes": {},
        "status": null,
        "type": null
      },
      "documentId": "PO1234"
    }
  ],
  "status": {
    "id": "6eedi425-8a84-40i5-8f3d-6544da943644",
    "name": "Approved",
    "type": "Approved"
  },
  "bookingType": "Standard",
  "driver": null,
  "comments": null,
  "bookingHistory": null,
  "fieldData": [
    {
      "field": { "id": "715b4fe4-86cc-4202-b469-0da7bd891ccc", "name": "Field 1" },
      "value": null
    }
  ]
}