File webhooks

Types of triggers

Webhooks can be triggered when a file is attached to an order, purchase order or shipment.

File

File is attached to an object

This webhook will fire when a file is attached/uploaded to an order, purchase order or shipment.

Payload

Example

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

{
  "webhookFilesId": 0,
  "webhookEventId": 0,
  "system": "string",
  "timestamp": "2023-01-01T12:00:00.0000000",
  "fileId": 0,
  "fileName": "string",
  "mimeType": "string",
  "goodsOwnerId": 0,
  "webhookTemplate": "string",
  "goodsOwnerName": "string",
  "context": {
    "order": {
      "orderId": 0
    },
    "purchaseOrder": {
      "purchaseOrderId": 0
    },
    "shipment": {
      "shipmentId": 0
    }
  }
}

Specification

WebhookFilesPayload
webhookFilesId	int	Internal ID for the webhook.
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.
fileId	int
fileName	string
mimeType	string
goodsOwnerId	int	The Ongoing WMS system id for the goods owner.
webhookTemplate	string	The name of the webhook type.
goodsOwnerName	string
context	WebhookFilesContext	An element of type WebhookFilesContext.

WebhookFilesContext
order	WebhookFilesContextOrder	An element of type WebhookFilesContextOrder.
purchaseOrder	WebhookFilesContextPurchaseOrder	An element of type WebhookFilesContextPurchaseOrder.
shipment	WebhookFilesContextShipment	An element of type WebhookFilesContextShipment.

WebhookFilesContextOrder
orderId	int

WebhookFilesContextPurchaseOrder
purchaseOrderId	int

WebhookFilesContextShipment
shipmentId	int