Shipment webhooks

Types of triggers

Webhooks can be triggered on the following events related to inbound and outbound shipments.

Inbound shipment

Inbound shipment status is changed

This webhook will fire when an inbound shipment's status is changed.

Outbound shipment status is changed

This webhook will fire when an outbound shipment's status is changed.

Payload

Example

When the webhook is triggered, the following payload will be delivered to the webhook endpoint.

{
  "webhookShipmentsId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "shipmentId": 0,
  "goodsOwnerId": 0,
  "goodsOwnerName": "string",
  "path": "string",
  "webhookTemplate": "string",
  "byComputer": {
    "computerId": 0,
    "computerName": "string"
  }
}

Specification

WebhookShipmentPayload
webhookShipmentsId	int
webhookEventId	int	Internal ID for this particular event.
system	string	The name of the Ongoing WMS instance where the event happened.
timestamp	string	When the event happened.
shipmentId	int
goodsOwnerId	int	The Ongoing WMS system id for the goods owner.
goodsOwnerName	string
path	string	REST API path to the resource.
webhookTemplate	string	The name of the webhook type.
byComputer	ByComputerInfo	An element of type ByComputerInfo.

ByComputerInfo
computerId	int	Ongoing WMS workstation ID of the workstation which the user was logged in to.
computerName	string	Ongoing WMS workstation name of the workstation which the user was logged in to.