Skip to main content
All CollectionsEMERGE API
How to create Webhook for EMERGE Open API
How to create Webhook for EMERGE Open API
Gigi Nguyen avatar
Written by Gigi Nguyen
Updated over 2 months ago

Currently, EMERGE does not offer public access to the Open API for all live users. If you need to use this feature, please contact our support team for assistance.

1. Introduction

  • This webhook provides real-time updates about product, sales order, invoice and inventory

  • A POST request containing the entire document (including both changed and unchanged fields) will be sent to your registered URL whenever an event is triggered in EMERGE.

2. How to register a Webhook URL

Go to Basic Settings / Webhook / Input Webhook URL

Click Save

3. Event types

  • Product: product.updated, product.created, product.deleted;

  • SalesOrder: salesOrder.updated, salesOrder.created, salesOrder.deleted

  • Invoice: invoice.updated, invoice.created, invoice.deleted

  • Inventory: inventory.updated

4. Payload structure

  • HTTP Method: POST

  • Example payload:

[
{
"EventType": "product.updated",
"DateCreated": "2024-10-14T04:43:15.9123224Z",
"Data": {
"ProductId": 10070,
"ParentProduct": null,
"Name": "Product A",
"ItemCode": "SKU-A",
"PurchasePrice": null,
"SellingPrice": null,
"DefaultProductCategoryId": 34,
"ProductCategories": [
{
"Id": 34,
"Name": "Category Name"
}
],
"ProductBrandId": 41,
"ProductBrand": null,
"IsDeleted": false,
"ProductVariantViewModelList": [
{
"VariantId": 10071,
"Name": "Product A | Variant X"
}
]
}
}
]
Did this answer your question?