Webhooks deliver order and shipment information to an external system when events occur. Use webhooks to keep external systems updated with shipment and tracking data after orders are processed. Your external system must support webhooks and be able to receive data on a URL endpoint.
Key concepts
Event — an action in the system that fires a webhook when it occurs, such as Order created or Shipment created
Order channel – a connection between nShift Delivery and an external order source
Create a webhook to deliver order and shipment information to an external system when a selected event occurs.
Steps
-
Go to >
-
Select
-
Enter a name for the webhook
-
Enter the URL endpoint
-
Select an event in Trigger
-
Select the order channels for the webhook
-
Select
Result
The webhook is created and appears in the Webhooks list.
Field descriptions
|
Field |
Description |
|---|---|
|
Name |
Identifies the webhook in the Webhooks list |
|
URL |
The endpoint that receives the webhook payload — must use the HTTPS format |
|
Active |
Enables or disables the webhook — enabled by default |
|
Event |
The action that fires the webhook payload |
|
Order channels |
The order channels the webhook applies to — all order channels are enabled by default |
Events
- Order created
-
Triggered when a new order is created
- Order updated
-
Triggered when an order is updated
- Order deleted
-
Triggered when an order is deleted
- Shipment created
-
Triggered when a shipment is created from an order
View webhook events to check the delivery status of payloads sent to the external system.
Steps
The Webhook events page shows the status of each event triggered by the webhook, including the response code, latest attempt, and number of attempts.
Delete a webhook to remove it from your account
Note
Deleting a webhook is permanent and cannot be undone.
Steps
Related topics
Order channels – Configure and manage connections to external systems