Event Catalog

This catalog lists all event types available for webhook subscriptions.

TypeScript Interfaces

All webhook events share common base properties. Copy these interfaces to type your webhook handlers:

/** Base event properties included in all webhook events */
interface BaseEvent {
  /** Unique event identifier (UUID) */
  id: string;
  /** Event type (e.g., "inventory.received", "order.status.changed") */
  kind: string;
  /** ISO 8601 timestamp */
  time: string;
  /** Transaction identifier for grouping related events */
  transactionId: string;
}

/** Union type of all webhook event kinds */
type EventKind =
  // Inventory events
  | "inventory.received"
  | "inventory.produced"
  | "inventory.modified"
  | "inventory.moved"
  | "inventory.bundled"
  | "inventory.destroyed"
  | "inventory.wasted"
  | "inventory.merged"
  | "inventory.merge.reverted"
  | "inventory.restored"
  | "inventory.restored_from_history"
  // Order events
  | "order.created"
  | "order.updated"
  | "order.status.changed"
  | "order.deleted"
  // Shipment events
  | "shipment.created"
  | "shipment.updated"
  | "shipment.status.changed"
  | "shipment.items.assigned"
  | "shipment.deleted"
  // Transfer events
  | "transfer.status.changed"
  // Purchase order events
  | "purchase.created"
  | "purchase.updated"
  | "purchase.deleted"
  // Customer events
  | "customer.created"
  | "customer.updated"
  | "customer.deleted"
  // Supplier events
  | "supplier.created"
  | "supplier.updated"
  | "supplier.deleted"
  // Transport events
  | "transport.created"
  | "transport.updated"
  | "transport.deleted"
  // Form events
  | "form.submitted";

Event Categories

Inventory Events

Events related to inventory entities (items, products, bundles).

Event	Description
`inventory.received`	Inventory received into the system
`inventory.produced`	Inventory created via production/transformation
`inventory.modified`	Inventory attributes updated
`inventory.moved`	Inventory moved to new location
`inventory.bundled`	Inventory added to a bundle
`inventory.destroyed`	Inventory destroyed/consumed
`inventory.wasted`	Inventory marked as waste
`inventory.merged`	Inventory items merged together
`inventory.merge.reverted`	Merge operation reverted
`inventory.restored`	Inventory restored via deconstruction
`inventory.restored_from_history`	Inventory restored from a historical snapshot

View Inventory Events →

Order Events

Events related to customer orders.

Event	Description
`order.created`	New order created
`order.updated`	Order details updated
`order.status.changed`	Order status updated
`order.deleted`	Order deleted

View Order Events →

Shipment Events

Events related to shipments.

Event	Description
`shipment.created`	New shipment created
`shipment.updated`	Shipment details updated
`shipment.status.changed`	Shipment status updated
`shipment.items.assigned`	Items assigned to shipment
`shipment.deleted`	Shipment deleted

View Shipment Events →

Transfer Events

Events related to internal transfers.

Event	Description
`transfer.status.changed`	Transfer status updated

View Transfer Events →

Purchase Order Events

Events related to purchase orders from suppliers.

Event	Description
`purchase.created`	Purchase order created
`purchase.updated`	Purchase order updated
`purchase.deleted`	Purchase order deleted

View Purchase Order Events →

Customer Events

Events related to customers.

Event	Description
`customer.created`	Customer created
`customer.updated`	Customer updated
`customer.deleted`	Customer deleted

Supplier Events

Events related to suppliers.

Event	Description
`supplier.created`	Supplier created
`supplier.updated`	Supplier updated
`supplier.deleted`	Supplier deleted

Transport Events

Events related to transport carriers.

Event	Description
`transport.created`	Transport created
`transport.updated`	Transport updated
`transport.deleted`	Transport deleted

Form Events

Events related to form submissions.

Event	Description
`form.submitted`	Form submitted

View Form Events →

Common Event Properties

All events include these base properties:

Property	Type	Description
`id`	string	Unique event identifier (UUID)
`kind`	string	Event type (e.g., `inventory.received`)
`time`	string	ISO 8601 timestamp
`transactionId`	string	Transaction identifier for grouping related events

Many inventory events also include:

Property	Type	Description
`flowId`	string	Flow identifier