Webhooks

Webhooks are a way to notify client systems in real time when something changes within the Skladon platform.

Webhook types

Currently, webhooks can be registered for the following types of events:

• CREATE_ORDER - creating of order

• UPDATE_ORDER - updating order

• UPDATE_ORDER_STATUS - order status update

• CREATE_PRODUCT - creating of product

• UPDATE_PRODUCT - updating product

• CREATE_RECEIVING - creating of receiving

• UPDATE_RECEIVING - updating receiving

• UPDATE_RECEIVING_STATUS - receiving status update

• CREATE_RETURN - creating of return

• UPDATE_RETURN - updating return

• UPDATE_RETURN_STATUS - return status update

• CREATE_STOCK_MOVEMENT_STOCK_CORRECTION - created stock movement of type stock_correction

• CREATE_STOCK_MOVEMENT_COMPLETITION - created stock movement of type completition

If any of above types of actions happens in Skladon systems and there is registered webhook. - webhook is sent.

Webhook subscription

You can have multiple webhooks for any type of actions, but you should have only working urls enabled. Not working webhooks will be automatically deactivated in the future.

In order to use webhooks you should have url(endpoint) ready at your side. To this url we send either GET or POST request.

GET webhook

For GET webhooks, we call your URL and append the entity ID as a parameter. You should then retrieve the entity details on your end.

For example. you define GET webhook url https://app.myclientapp/api/orders/changes/ and there has been change of your order with eshopOrderId 123456.

In this case we call url https://app.myclientapp/api/orders/changes/123456 .

POST webhook

POST webhooks, on the other hand, send the new entity data directly in the request payload, so there is no need to fetch the entity details separately.

Example

{
   "eshopReceivingId":"ESHOP_RECIVING_ID_123",
   "carrierInfo":null,
   "deliveryNoteNumber":null,
   "deliveryType":null,
   "description":"Example description",
   "driverCompany":null,
   "driverDispatcherContact":null,
   "driverName":null,
   "driverPhone":null,
   "driverTrailerLicensePlate":null,
   "duty":false,
   "estimatedDelivery":"2024-06-13T00:00:00.000Z",
   "handlingUnits":"box_loose",
   "packagings":[
      
   ],
   "products":[
      {
         "sku":"TEST_SKU_1",
         "quantity":6,
         "lot":null,
         "received":null,
         "expirationDate":null,
         "lineState":"D"
      },
      {
         "sku":"TEST_SKU_2",
         "quantity":1,
         "lot":null,
         "received":null,
         "expirationDate":null,
         "lineState":"D"
      },
      {
         "sku":"TEST_SKU_3",
         "quantity":2,
         "lot":null,
         "received":2,
         "expirationDate":null,
         "lineState":"E"
      }
   ],
   "status":"received",
   "supplier":"AMAZON",
   "trackingNumber":null,
   "unitsAmount":1,
   "urgent":null
}

Format of data in the payload is same as for GET endpoints in API.

API

Webhook repeating

If a successful status code is not returned when delivering a webhook, the delivery is retried automatically. Retries are attempted for up to 48 hours, with exponentially increasing intervals between attempts, up to a maximum of 20 retries. If all retry attempts fail, the webhook is deactivated and a notification email is sent. Once the issue is resolved, the webhook can be reactivated via the Webhooks API.

Webhooks API documentation

You can find descriptions of webhook endpoint on the link below.

Webhooks