Event Catalog

/** 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.shortshipped"
  | "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.receivedshort"
  | "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"
  // Vision events
  | "vision.alert.triggered"
  | "vision.alert.resolved";