Webhooks

EZI INTEGRATION

Label Webhook

The Label Webhook allow us to send you information whenever a label is generated on your label portal. This information goes to a URL that you can setup, and includes the details that follow.

You can find an example of the kind of data that will be sent in JSON format to any URL that you setup. This includes some sample data, and shows that even if a field is empty, it is still included, and also that a label generated for multiple items will include each item added to the portal:

{

"labelID": 1457029,

"checkoutHash": "63ac86xx-38b1-4af3-a968-6a42747fcbxx",

"labelCreated": "2026-10-19 08:53:59",

"orderOriginal": "303-9278670-7473113",

"carrierTracking": "9999562514063910163413",

"labelServiceID": 160,

"serviceNameRetailer": "AT - Post AT home return 0-4kg",

"serviceCarrierName": "Austria Post",

"address": {

"name": "Alexandra",

"address1": "Street Name 40",

"address2": "",

"address3": "",

"town": "Pyhra",

"county": "NO - Niederösterreich",

"postcode": "12345",

"country": "AT"

},

"email": "test@gmail.com",

"items": [

{

"labelProductID": 624588,

"quantity": 1,

"name": "Product Name",

"hs": "61090000",

"sku": "CKB-MPPSAGE",

"origin": "CN",

"price": "10.00",

"weight": "1.00",

"barcode1": "BARCODE",

"barcode2": null,

"action": "Return for refund",

"reason": "Does Not Fit",

"image": null

}

]

}

Once your have setup your URL, you can add it to your label portal directly. Simply log in to your Ezi Returns account and go to Label Portal in the top menu. Edit the label portal you'd like to add the Webhook URL to (you can use the same URL for multiple portals if you have them) and go to the Settings tab. There, scroll to the bottom of the page, where you'll find a field called Webhook URL.

Technical FAQs

Is the webhook signed (HMAC signature header or shared secret)?

Yes, we include a header called X-Signature and this is a HMAC signature (specifically HMAC-SHA256 with the raw body of the request). The secret is will be your Ezi Account Code, which can be given on request.

Do you retry failed deliveries?

Yes, we try 5 times over the course of a few hours if the delivery hasn’t returned a status code starting with a 2

Can returns sent be backdated or limited?

Unfortunately, they cannot at this time. If you'd like to gather your past label portal information, you can download it from the Labels Generated report in the portal.