copy Copy chevron-down
Overview Webhook ZORT have webhook to callback when some events are triggered. The system will send request by "POST" method to your endpoint URL that set in the system.
Common Request Parameters
Every request will be sent with Header to endpoint URL.
triangle-exclamation
A trigger with by API request will be not sent to webhook that use the same API Key.
How To Set Webhook
Set manually in ZORT portal.
Go to menu Setting --> Integration --> API Reference --> Webhook.
Input key and endpoint URL and click "Verify and Save".
You can send request to update webhook information.
POST https://open-api.zortout.com/v4/Webhook/UpdateWebhook
Update webhook information.
Endpoint URL when product is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when product is modified.
If this value is null or blank, this trigger will be not active.
Endpoint URL when product is deleted.
If this value is null or blank, this trigger will be not active.
Endpoint URL when product quantity is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when order is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when order is modified or an order status is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when tracking no in order is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when payments in order is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when purchase is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when purchase is modified or a purchase status is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when payments in purchase is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when return order is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when return order is modified or a return order status is changed.
If this value is null or blank, this trigger will be not active.
updatereturnorderpaymenturl
Endpoint URL when payments in return order is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when return purchase is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when return purchase is modified or a return purchase status is changed.
If this value is null or blank, this trigger will be not active.
updatereturnpurchasepaymenturl
Endpoint URL when payments in return purchase is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when transfer is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when transfer is modified or a transfer status is changed.
If this value is null or blank, this trigger will be not active.
Endpoint URL when warehouse is deleted.
If this value is null or blank, this trigger will be not active.
Endpoint URL when warehouse is modified.
If this value is null or blank, this trigger will be not active.
Endpoint URL when warehouse is created.
If this value is null or blank, this trigger will be not active.
Endpoint URL when contact is deleted.
If this value is null or blank, this trigger will be not active.
Endpoint URL when contact is modified.
If this value is null or blank, this trigger will be not active.
Endpoint URL when contact is created.
If this value is null or blank, this trigger will be not active.
Parameter
Type
Description/Example
Response Code
200- Success
You can get current webhook information by calling "GETWEBHOOK " method.
GET https://open-api.zortout.com/v4/Webhook/GetWebhook
Get webhook information.
Parameter
Type
Description/Example
Endpoint URL when product is created.
Endpoint URL when product is modified.
Endpoint URL when product is deleted.
Endpoint URL when product quantity is changed.
Endpoint URL when order is create
Endpoint URL when order is modified or an order status is changed.
Endpoint URL when tracking no in order is changed.
Endpoint URL when payments in order is changed.
Endpoint URL when purchase is created
Endpoint URL when purchase is modified or a purchase status is changed.
Endpoint URL when payments in purchase is changed.
Endpoint URL when return order is created.
Endpoint URL when return order is modified or a return order status is changed.
updatereturnorderpaymenturl
Endpoint URL when payments in return order is changed.
Endpoint URL when return purchase is created.
Endpoint URL when return purchase is modified or a return purchase status is changed.
updatereturnpurchasepaymenturl
Endpoint URL when payments in return purchase is changed.
Endpoint URL when transfer is created.
Endpoint URL when transfer is modified or a transfer status is changed.
Endpoint URL when contact is created.
Endpoint URL when contact is modified.
Endpoint URL when contact is deleted.
If this value is null or blank, this trigger will be not active.
Endpoint URL when warehouse is created.
Endpoint URL when warehouse is modified.
Endpoint URL when warehouse is deleted.
If this value is null or blank, this trigger will be not active.
circle-check
Product Trigger
POST {Your Endpoint URL}
Send request when a product is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a product is modified.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATEPRODUCTQUANTITY
POST {Your Endpoint URL}
Send request when a product quantity is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a product is deleted.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when an order is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when an order is modified or an order status is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATEORDERPAYMENT
POST {Your Endpoint URL}
Send request when payments in order is changed.
Query Parameters
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
UPDATEORDERTRACKING
POST {Your Endpoint URL}
Send request when a tracking no in order is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when an order is deleted.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
ADDPURCHASEORDER
POST {Your Endpoint URL}
Send request when a purchase is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATEPURCHASEORDER
POST {Your Endpoint URL}
Send request when a purchase is modified or a purchase status is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATEPURCHASEORDERPAYMENT
POST {Your Endpoint URL}
Send request when payments in purchase is changed.
Query Parameters
UPDATEPURCHASEORDERPAYMENT
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
Payload (JSON format)
See detail in Ex. Payload JSON.
DELETEPURCHASEORDER
POST {Your Endpoint URL}
Send request when an purchase is deleted.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a return order is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATERETURNORDER
POST {Your Endpoint URL}
Send request when a return order is modified or a return order status is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATERETURNORDERPAYMENT
POST {Your Endpoint URL}
Send request when payments in return order is changed.
Query Parameters
Payment Status (Pending, Paid, Partial Payment, Excess Payment)
Payload (JSON format)
See detail in Ex. Payload JSON.
DELETERETURNORDER
POST {Your Endpoint URL}
Send request when an return order is deleted.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
circle-check
Return Purchase Order Trigger
ADDRETURNPURCHASEORDER
POST {Your Endpoint URL}
Send request when a return purchase is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATERETURNPURCHASEORDER
POST {Your Endpoint URL}
Send request when a return purchase is modified or a return purchase status is changed.
Query Parameters
UPDATERETURNPURCHASEORDER
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATERETURNPURCHASEORDERPAYMENT
POST {Your Endpoint URL}
Send request when payments in return purchase is changed.
Query Parameters
UPDATERETURNPURCHASEORDERPAYMENT
ReturnPurchaseOrder Number
Payload (JSON format)
See detail in Ex. Payload JSON.
DELETERETURNPURCHASEORDER
POST {Your Endpoint URL}
Send request when an return purchase is deleted.
Query Parameters
DELETERETURNPURCHASEORDER
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a transfer is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a transfer is modified or a transfer status is changed.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a contact is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a contact is modified.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
POST {Your Endpoint URL}
Send request when a warehouse is created.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
UPDATEWAREHOUSE
POST {Your Endpoint URL}
Send request when a warehouse is modified.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
DELETEWAREHOUSE
POST {Your Endpoint URL}
Send request when a warehouse is deleted.
Query Parameters
Payload (JSON format)
See detail in Ex. Payload JSON.
Last updated 7 months ago