About Webhooks
Webhooks are notifications sent to a specific URL when an event occurs in the system. For example, when a shipment is created, a webhook can be sent to a specific URL to notify that a shipment has been created.
The URL that will receive the webhook must be configured in the system, and the system will send an HTTP POST request to the configured URL when the event occurs.
Configurations
To configure a webhook, access the Integrations menu and click on the Create webhook button.
Request Data
POST /webhook HTTP/1.1
Host: your-system-url.com
Content-Length: 372
Content-Type: application/json
Signature: 99dc3769164a1d2e41b4b2403de283d35c1906e9701d2ccc7c761a46a8ec6a20
User-Agent: ..
Reqeust body:
json
{
"event": "shipment.created",
"payload": {
"shipment_id": 1,
"shipment": {
"id": 1 ,
"order_number": "580950",
"tracking_code": "TR097329",
"tracking_code_label": "LBL269407",
"created_by_id": 1,
"updated_by_id": 3,
"created_at": "2023-06-28T20:57:23+00:00",
"updated_at": "2023-07-06T12:18:20+00:00",
"shipment_status": 1,
"shipment_status_text": "Draft"
}
},
"event_at": "2023-07-06T12:19:32+00:00"
}