Where we stand today
**The HelloBooks Manufacturing API is on the roadmap, not yet shipped to /public/v1/*.** This page exists so integrators can preview the planned contract, register interest, and start designing against a stable shape.
Two facts to internalize before building:
- The manufacturing internal app routes (
/bom,/work-orders,/recipes,/quality-inspections,/subcontract-orders,/manufacturing-reports) exist today and serve the HelloBooks frontend. They authenticate user JWTs only and explicitly reject marketplace tokens withMarketplace app tokens cannot be used on user routes.Do not point your integration at them. - The public API gateway (
/public/v1/*) is live but currently exposes only auth-foundation, health, /me, and webhook-subscription endpoints. The curated subset for invoices/bills/customers is stubbed (501) pending follow-up work; manufacturing follows after that.
Subscribing to manufacturing topics on a webhook subscription today will create the subscription, but no events are published yet — the publisher work lands alongside the public-API exposure.
What will land
When manufacturing ships to the public API, the curated subset will mirror the internal HTTP shape with three changes:
- URL pattern:
/public/v1/orgs/:orgId/entities/:entityId/<resource>/...(vs internal/<resource>/...) - Auth: Bearer marketplace token (vs internal user session JWT)
- Response shape:
@internal-tagged fields stripped (e.g. raw repository internals will not be exposed)
Six resources are in scope:
| Resource | Internal route prefix today | Planned scope |
|---|---|---|
| BOM | /bom | bom:read, bom:create, bom:update, bom:delete |
| Work Orders | /work-orders | workOrder:read, workOrder:create, workOrder:update, workOrder:delete |
| Recipes | /recipes | recipe:read, recipe:create, recipe:update, recipe:delete |
| Quality Inspections | /quality-inspections | qualityInspection:read, qualityInspection:create, qualityInspection:update, qualityInspection:delete |
| Subcontract Orders | /subcontract-orders | subcontractOrder:read, subcontractOrder:create, subcontractOrder:update, subcontractOrder:delete |
| Manufacturing Reports | /manufacturing-reports | manufacturingReport:read |
Planned webhook events
Manufacturing will publish events through the existing webhook subscription mechanism (see webhook subscriptions quickstart). Topics will follow the standard <domain>.<resource>.<verb> pattern. Anticipated topics:
work_order.released— Work Order moves from Draft → InProgress (allocations created)work_order.completed— Work Order moves from InProgress → Completed (stock movements posted)work_order.cancelled— any non-completed → Cancelled (allocations released)bom.created/bom.updated/bom.archived/bom.restoredsubcontract_order.materials_issued/subcontract_order.goods_received/subcontract_order.completedquality_inspection.created/quality_inspection.completed
Lot traceability, ECO, and job-work-challan events (e.g. lot.created, eco.released, jobwork_challan.overdue) are tied to features still on feature branches and have no defined timeline yet.
How to register interest
If your integration depends on any of the above, contact your HelloBooks partner manager with:
- The resource(s) you need (BOM read-only? Work Order full lifecycle?)
- The use case (one or two sentences — "we run an ERP middleware that syncs WIP" beats "everything")
- Whether you need webhook events or polling is acceptable
- Your timeline / launch dependency
Prioritization is driven by partner demand. Concrete use cases move faster than wish lists.