Skip to content

stock.level_changed

A stock level changed: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends stock.level_changed to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

The quantity on hand of a product changed in a warehouse, for any reason. data is the stock level of that product, warehouse and unit; when nothing is left, quantity is "0". Changes made within a few seconds of each other arrive as one event, with the final state.

Data

data holds a stock level, with the fields of Warehouses and stock.

Example

Body of stock.level_changedJSON
{
  "api_version": "v1",
  "data": {
    "id": "EXAMPLE-LEVEL-0001",
    "lot_count": 2,
    "product_id": "00000000-0000-4000-8000-000000000011",
    "product_kind": "goods",
    "quantity": "12.5",
    "unit": "kg",
    "warehouse_id": "00000000-0000-4000-8000-000000000041"
  },
  "id": "00000000-0000-4000-8000-00000000010a",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "stock.level_changed"
}

Related

  • webhook-events
  • warehouses-and-stock
  • verify-webhook-signatures