> For the complete documentation index, see [llms.txt](https://support.ordereazi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.ordereazi.com/developers/webhooks/event-catalogue.md).

# Event Catalogue

## 📋 Webhook Event Catalogue

OrderEazi Central supports over 60 webhook events across 6 categories. Each event has a unique integer value used when registering webhooks via the API.

> The `Value` column shows the integer to pass as the `process` parameter when creating a webhook via the API.

### 📦 Warehouse and Fulfilment

| Event                           | Value | Description                             | Payload Type             |
| ------------------------------- | ----- | --------------------------------------- | ------------------------ |
| `GRVCompleted`                  | 0     | Goods received voucher completed        | WebhookDocument          |
| `OrderPickingCompleted`         | 1     | Picking slip fully picked               | WebhookPickingslip       |
| `OrderCheckingCompleted`        | 2     | Checking process completed              | WebhookChecking          |
| `OrderDispatched`               | 3     | Order dispatched                        | WebhookDocument          |
| `WarehouseEnteredStocktakeMode` | 4     | Warehouse entered stocktake mode        | WebhookStocktake         |
| `WarehouseExitedStocktakeMode`  | 5     | Warehouse exited stocktake mode         | WebhookStocktake         |
| `OrderPickingStarted`           | 6     | Picking slip opened/started             | WebhookPickingslip       |
| `OrderPickingCancelled`         | 7     | Picking slip cancelled                  | WebhookPickingslip       |
| `OrderPickingException`         | 8     | Exception on a picking slip line        | WebhookPickingslip       |
| `GRVStarted`                    | 9     | GRV started                             | WebhookDocument          |
| `CheckingCancelled`             | 10    | Checking cancelled                      | WebhookChecking          |
| `CheckingStarted`               | 11    | Checking started                        | WebhookChecking          |
| `CustomerReturn`                | 12    | Customer return (credit note) processed | WebhookDocument          |
| `SupplierReturn`                | 13    | Supplier return processed               | WebhookDocument          |
| `WarehouseTransferDispatch`     | 14    | Warehouse transfer dispatched           | WebhookWarehouseTransfer |
| `WarehouseTransferReceive`      | 15    | Warehouse transfer received             | WebhookWarehouseTransfer |
| `OrderReadyForDelivery`         | 16    | Order ready for delivery                | WebhookDocument          |
| `StocklevelChanged`             | 26    | Stock level changed in inventory        | WebhookStocklevel        |
| `PickingSlipsAllocated`         | 28    | Picking slips allocated to a project    | ProjectModel             |

### 📁 Projects and CRM

| Event                                | Value | Description                         | Payload Type |
| ------------------------------------ | ----- | ----------------------------------- | ------------ |
| `ProjectUpdated`                     | 17    | General project update              | ProjectModel |
| `ProjectHistory`                     | 18    | Project history entry written       | Raw JSON     |
| `ProjectReadyForDelivery`            | 19    | Project marked ready for delivery   | ProjectModel |
| `ProjectReadyForProduction`          | 20    | Project marked ready for production | ProjectModel |
| `ProjectClientCalled`                | 21    | Click-to-call event                 | Raw JSON     |
| `ProjectQuoted`                      | 22    | Quote created for a project         | ProjectModel |
| `ProjectCancelled`                   | 23    | Project cancelled                   | ProjectModel |
| `ProjectCompleted`                   | 24    | Project completed                   | ProjectModel |
| `ProjectSalesRepChanged`             | 25    | Sales rep changed on a project      | ProjectModel |
| `OrderApproved`                      | 27    | Project/order approved              | ProjectModel |
| `ProjectExchangeRateUpdated`         | 31    | Exchange rate updated               | ProjectModel |
| `ProjectDueDateUpdated`              | 32    | Due date updated                    | ProjectModel |
| `ProjectWinProbabilityUpdated`       | 33    | Win probability updated             | ProjectModel |
| `ProjectLastInContactDateUpdated`    | 34    | Last in-contact date updated        | ProjectModel |
| `ProjectInProductionUpdate`          | 35    | In-production status updated        | ProjectModel |
| `ProjectDescriptionUpdate`           | 36    | Project description updated         | ProjectModel |
| `ProjectEarliestDeliveryDateUpdated` | 45    | Earliest delivery date updated      | ProjectModel |
| `OrderAccepted`                      | 41    | Project accepted                    | ProjectModel |
| `OrderDeclined`                      | 42    | Project declined                    | ProjectModel |

### 🧾 Document Creation

| Event                            | Value | Description                           | Payload Type       |
| -------------------------------- | ----- | ------------------------------------- | ------------------ |
| `DocumentCreatedTaxInvoice`      | 46    | Tax invoice created                   | WebhookDocument    |
| `DocumentCreatedPurchaseOrder`   | 47    | Purchase order created                | WebhookDocument    |
| `DocumentCreatedGrv`             | 48    | GRV document created                  | WebhookDocument    |
| `DocumentCreatedDeliveryNote`    | 49    | Delivery note created                 | WebhookDocument    |
| `DocumentCreatedSupplierReturn`  | 50    | Supplier return document created      | WebhookDocument    |
| `DocumentCreatedCustomerReturn`  | 51    | Credit note / customer return created | WebhookDocument    |
| `DocumentCreatedSupplierInvoice` | 52    | Supplier invoice created              | WebhookDocument    |
| `DocumentCreatedPickSlip`        | 53    | Pick slip document created            | WebhookPickingslip |
| `DocumentCreatedSalesOrder`      | 54    | Sales order created                   | WebhookDocument    |
| `DocumentCreatedQuote`           | 55    | Quote document created                | WebhookDocument    |
| `DocumentCreatedProformaInvoice` | 56    | Proforma invoice created              | WebhookDocument    |

### 🔄 Document ERP Sync

These events fire after a document has been successfully synced to your connected accounting system.

| Event                           | Value | Description                    | Payload Type    |
| ------------------------------- | ----- | ------------------------------ | --------------- |
| `DocumentSyncedSalesOrder`      | 57    | Sales order synced to ERP      | WebhookDocument |
| `DocumentSyncedTaxInvoice`      | 58    | Tax invoice synced to ERP      | WebhookDocument |
| `DocumentSyncedPurchaseOrder`   | 59    | Purchase order synced to ERP   | WebhookDocument |
| `DocumentSyncedSupplierReturn`  | 60    | Supplier return synced to ERP  | WebhookDocument |
| `DocumentSyncedCustomerReturn`  | 61    | Credit note synced to ERP      | WebhookDocument |
| `DocumentSyncedSupplierInvoice` | 62    | Supplier invoice synced to ERP | WebhookDocument |

### 📦 Products

> Product webhooks only fire when the `FireProductWebhooks` instance setting is enabled. Speak to your OrderEazi representative to enable this.

| Event            | Value | Description     | Payload Type   |
| ---------------- | ----- | --------------- | -------------- |
| `ProductCreated` | 37    | Product created | WebhookProduct |
| `ProductUpdated` | 38    | Product updated | WebhookProduct |

### 🔢 Serials and Shipments

| Event                  | Value | Description                               | Payload Type |
| ---------------------- | ----- | ----------------------------------------- | ------------ |
| `SerialAllocated`      | 39    | Serial number allocated to a project line | Raw JSON     |
| `SerialsAllocated`     | 40    | Multiple serials allocated                | Raw JSON     |
| `ShipmentInTransit`    | 29    | Courier reports shipment in transit       | Raw JSON     |
| `ShipmentDelivered`    | 30    | Courier reports shipment delivered        | Raw JSON     |
| `ShipmentAtCourierHub` | 43    | Shipment scanned at a courier hub         | Raw JSON     |
| `ShipmentPODReceived`  | 44    | Proof of delivery received                | Raw JSON     |

### ✅ Summary

* OrderEazi supports over 60 webhook events across 6 categories
* Each event has a unique integer value used as the `process` parameter in the API
* Events are grouped into: Warehouse, Projects/CRM, Document Creation, Document ERP Sync, Products, and Serials/Shipments
* Most events use structured payload types (WebhookDocument, WebhookPickingslip, etc.) documented in the Payload Reference
* Some events (ProjectHistory, ProjectClientCalled, serials, shipments) use raw JSON payloads