Skip to main content

Mapping guide

Map your household model to Headlight’s vendor-neutral embed schema.

People

Use stable partner-scoped IDs (for example member:person-123). Provide firstName, optional lastName, and optional relationshipType when the person is a household member.

Relationships

Send flat relationships[] entries with fromPersonId, toPersonId, and relationshipType. The adapter expands these into layout inputs.

Trusts and entities

Namespace IDs (trust:..., entity:...) and include display names plus enum fields (trustType, entityType, etc.).

Round-trip IDs

nodeClick events return partner-scoped IDs via bidirectional maps in the adapter. Do not rely on internal React Flow node IDs.