Label Webhook
This notification is sent when the Label topic is requested. For those who subscribe to this topic for more than one trigger event, the "trigger" property is included in the payload for reference.
| Response Header | Description |
|---|---|
| X-Loop-Signature | Hashed Webhook Secret Key |
The X-Loop-Signature is a base-64, HMAC hash of body payload using the Webhook Secret provided by Loop.
Note: Before attempting to create your hash of the POST request body, make sure slashes have been escaped & newlines have been removed from the JSON.
| Field | Description |
|---|---|
| topic | Webhook type (label) |
| trigger | Event that triggered the webhook (created, updated, requested, closed) |
| shop_id | The unique identifier of the shop that created the webhook |
| id | Loop return ID |
| order_id | Loop order ID |
| provider_order_id | Shopify order ID |
| carrier | Name of carrier |
| tracking_number | The tracking number for the shipment |
| label_status | Status of the shipment according to EasyPost. N/A: no shipment status, pre_transit, in_transit, out_for_delivery, delivered, error, failure |
| label_updated_at | Date and time (ISO 8601 format) when the last status update occurred |
| shipment_id | The unique identifier associated with the shipment, assigned by Loop |
Response
{
"topic": "label",
"trigger": "label.updated",
"shop_id": "9876",
"id": "12345",
"order_id": "1234567890",
"provider_order_id": 1029384756,
"carrier": "USPS",
"tracking_number": "28735625627856237856287",
"label_status": "in_transit",
"label_updated_at": "2019-04-01T12:00:00+00:00",
"shipment_id": "6789998212"
}