> For the complete documentation index, see [llms.txt](https://support.ordereazi.com/central/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/central/developers/webhooks/event-catalogue.md). # Event catalogue Every event you can register an OrderEazi webhook for, when it's sent, and what it sends. You register each webhook for one event, so you need to know when each event is sent and what it sends. The tables below list every event OrderEazi sends. The [Payload reference](/central/developers/webhooks/payload-reference.md) describes each payload. Many events are about a project, OrderEazi's record of an order, with its lines and documents. ### How to use event names and numbers * **Register by name:** Send the event's name as `process`, such as `process=OrderDispatched`. See [Managing webhooks](/central/developers/webhooks/managing-webhooks.md). * **Read by number:** `GET /api/webhook/list` returns each webhook's event as a number. The **Number** column below tells you which event it is. * **Tell events apart:** Each delivery's `X-OE-Webhook-Process` header holds the event's name, so one endpoint can take several events. ### Orders, picking, and checking A picking slip is the list a picker works from. Checking is scanning picked stock before it's packed. | Event | Number | Sent when | Payload | | ------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------- | ----------------------- | | `OrderApproved` | 27 | An order is approved on its workflow. | Project | | `PickingSlipsAllocated` | 28 | Picking slips are created for an order. | Picking slips allocated | | `OrderPickingStarted` | 6 | Picking starts on a picking slip. | Picking slip | | `OrderPickingException` | 8 | A picker reports a problem with a line. | Picking slip | | `OrderPickingCompleted` | 1 | A picking slip is fully picked. | Picking slip | | `OrderPickingCancelled` | 7 | Picking is cancelled. | Picking slip | | `CheckingStarted` | 11 | Checking starts on an order. | Checking | | `OrderCheckingCompleted` | 2 | Checking is completed. | Checking | | `CheckingCancelled` | 10 | Checking is cancelled. | Checking | | `OrderDispatched` | 3 | A trip sheet (the list of deliveries a driver takes out) is dispatched. One is sent for each Delivery Note on it. | Document | ### Warehouse and stock | Event | Number | Sent when | Payload | | ------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------- | ------------------ | | `GRVStarted` | 9 | Receiving starts against a Purchase Order, on a GRV (Goods Received Voucher, the record of a delivery received). | Document | | `GRVCompleted` | 0 | A GRV is completed. | Document | | `WarehouseTransferDispatch` | 14 | A warehouse transfer is dispatched. | Warehouse transfer | | `WarehouseTransferReceive` | 15 | A warehouse transfer is received. | Warehouse transfer | | `StocklevelChanged` | 26 | Stock levels change. Changes are sent in batches of up to 1,000. | Stock levels | | `WarehouseEnteredStocktakeMode` | 4 | Counting starts on a stocktake. | Stocktake | | `WarehouseExitedStocktakeMode` | 5 | A stocktake is finalised. | Stocktake | | `SerialAllocated` | 43 | A serial number is allocated to a project line. | Serial allocated | ### Projects and workflow | Event | Number | Sent when | Payload | | --------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | | `ProjectUpdated` | 17 | A project's details change, or it moves to another section of its workflow. | Project | | `ProjectHistory` | 18 | Anything is added to a project's history. | Project history | | `ProjectQuoted` | 22 | A Quote is created. Sends the whole project. | Project | | `ProjectReadyForProduction` | 20 | A project reaches its workflow's Ready For Production step. | Project | | `ProjectInProductionUpdate` | 36 | A project's production status changes. | Project summary | | `ProjectReadyForDelivery` | 19 | A project reaches a step that books its courier automatically. | Courier booking | | `ProjectCompleted` | 24 | A project moves into its workflow's completed section. | Project | | `ProjectCancelled` | 23 | A project is cancelled. | Project | | `ProjectSalesRepChanged` | 25 | A project's sales rep changes. | Project | | `ProjectDescriptionUpdate` | 37 | A project's description changes. | Project summary | | `ProjectDueDateUpdated` | 32 | A project's due date changes. | Project summary | | `ProjectExchangeRateUpdated` | 31 | A project's exchange rate changes. | Project summary | | `ProjectWinProbabilityUpdated` | 33 | A project's win probability changes. | Project summary | | `ProjectLastInContactDateUpdated` | 34 | A project's last-in-contact date changes. | Project summary | | `ProjectClientCalled` | 21 | Someone calls the client from a project. | Client called | | `OnWorkflowActionCompleted` | 35 | A step on a project's workflow is completed, if the step has **Fire "Action Completed" webhook** ticked in the workflow editor. | Workflow step completed | ### Documents created | Event | Number | Sent when | Payload | | -------------------------------- | ------ | ------------------------------------ | ------------ | | `DocumentCreatedQuote` | 59 | A Quote is created. Sends the Quote. | Document | | `DocumentCreatedProformaInvoice` | 60 | A Proforma Invoice is created. | Document | | `DocumentCreatedSalesOrder` | 58 | A Sales Order is created. | Document | | `DocumentCreatedPickSlip` | 57 | A picking slip document is created. | Picking slip | | `DocumentCreatedDeliveryNote` | 53 | A Delivery Note is created. | Document | | `DocumentCreatedTaxInvoice` | 50 | A Tax Invoice is created. | Document | | `DocumentCreatedPurchaseOrder` | 51 | A Purchase Order is created. | Document | | `DocumentCreatedGrv` | 52 | A GRV is created. | Document | | `DocumentCreatedSupplierInvoice` | 56 | A Supplier Invoice is created. | Document | ### Documents synced to your accounting system These are sent when a document gets its number from your accounting system, either through an accounting app or through `PATCH /api/{pro}/document/{documentNumber}`. See [Projects and documents](/central/developers/api-guides/projects-and-documents.md). | Event | Number | Sent when | Payload | | ------------------------------- | ------ | ----------------------------- | -------- | | `DocumentSyncedSalesOrder` | 61 | A Sales Order is synced. | Document | | `DocumentSyncedTaxInvoice` | 62 | A Tax Invoice is synced. | Document | | `DocumentSyncedPurchaseOrder` | 63 | A Purchase Order is synced. | Document | | `DocumentSyncedSupplierInvoice` | 66 | A Supplier Invoice is synced. | Document | | `DocumentSyncedCustomerReturn` | 65 | A Credit Note is synced. | Document | | `DocumentSyncedSupplierReturn` | 64 | A supplier return is synced. | Document | ### Returns and shipments The shipment events are sent as an order moves through its workflow's shipping steps, one for each shipment on the order. | Event | Number | Sent when | Payload | | ------------------------------- | ------ | --------------------------------------------- | -------- | | `CustomerReturn` | 12 | A client return is completed. | Document | | `SupplierReturn` | 13 | A supplier return is completed. | Document | | `DocumentCreatedCustomerReturn` | 55 | A Credit Note is created for a client return. | Document | | `DocumentCreatedSupplierReturn` | 54 | A supplier return document is created. | Document | | `ShipmentInTransit` | 29 | The shipment is in transit. | Shipment | | `ShipmentAtCourierHub` | 47 | The shipment is at the courier's hub. | Shipment | | `ShipmentDelivered` | 30 | The shipment is delivered. | Shipment | | `ShipmentPODReceived` | 48 | Proof of delivery is received. | Shipment | ### Products and clients > **Note:** Product events are off by default. Ask OrderEazi support to turn them on for your organisation. | Event | Number | Sent when | Payload | | --------------------- | ------ | ------------------------------------------------------------ | ------------- | | `ProductCreated` | 38 | A product is created. | Product | | `ProductUpdated` | 39 | A product is changed. | Product | | `BranchClientCreated` | 40 | A client is linked to a branch. | Branch client | | `BranchClientUpdated` | 41 | A client's branch details, such as its credit limit, change. | Branch client | | `BranchClientDeleted` | 42 | A client is removed from a branch. | Branch client | Product changes are gathered every 30 seconds, so product events can take a little longer to arrive than other events. ### Related pages * [Payload reference](/central/developers/webhooks/payload-reference.md): what each payload holds * [Managing webhooks](/central/developers/webhooks/managing-webhooks.md): register for an event * [Webhooks](/central/developers/webhooks.md): how webhooks work * [Delivery and troubleshooting](/central/developers/webhooks/delivery-and-troubleshooting.md): retries and resending