Hudu Documentation Workflows

Working Hudu as the IT documentation system of record — company-scoped reads and writes, the archive-over-delete discipline, and correlating Hudu assets with other systems via integration lookup.

How to keep Hudu — the IT documentation platform — useful rather than stale. Hudu holds companies, assets, articles, and passwords, plus the relationships between them. Two habits matter most: scope to a company, and archive rather than delete, because documentation is reference material you’ll want back.

Signatures are on hudu; this page is the conventions.

Scope to a company

Most Hudu entities belong to a company, and company_id is the main way to narrow reads. Resolve the company first, then work within it.

# Find the company
hudu_search(query="Acme Corp")

# List that company's assets
hudu_get(entity_type="asset", company_id=42)

# A single record by ID
hudu_get(entity_type="article", id=987)

hudu_get filters by entity_type (company, asset, article, …) plus company_id / name / id. For a broad text sweep when you don’t know where something lives, hudu_search(query=...) spans entities.

Creating documentation

name is required; data carries the rest of the record. Scope company-owned entities with company_id.

hudu_create(entity_type="asset", name="Core Switch — Bldg A",
            company_id=42, data={ ... })

As with the other entity-typed systems, read an existing record of the same type first to see the field shape data expects — it varies by asset layout.

Archive over delete

This is the Hudu discipline. hudu_update carries an action, and the “soft delete” you almost always want is archive, not a hard hudu_delete.

# Update fields
hudu_update(entity_type="asset", id=555, action="update", data={ ... })

# Retire a record but keep it recoverable
hudu_update(entity_type="asset", id=555, action="archive")

# Bring it back
hudu_update(entity_type="asset", id=555, action="unarchive")

Correlating with other systems

Hudu often documents assets that also live in another system — most notably the ConnectWise Automate RMM. hudu_lookup is the bridge: keyed by lookup_type, it resolves an external system’s identifier to a Hudu resource and back.

hudu_lookup(lookup_type="<lookup>", integration_slug="...",
            integration_identifier="...")

Supply whichever identifier fields the lookup needs (integration_id, integration_slug, integration_identifier, resource_type/resource_id, company_id). Reach for this when you’re trying to tie a Hudu asset to its record in CWA or another integration rather than matching by name — names drift, integration identifiers don’t.

Where Hudu fits

Hudu is the documentation layer over the infrastructure the other tools operate: the CWA-managed endpoints, the hosts on the Service Map, and customer environments. Keep it current as the real state changes — stale documentation is worse than none.

  • hudu — the hudu_* signatures and entity model
  • cwa — the RMM whose assets Hudu documents
  • Service Map — where Hudu sits among the IT systems