Skip to main content
This page provides an overview of all Speckle connectors and links to their detailed documentation. Each connector follows the same fundamental data model but has connector-specific extensions and behaviors.

Connectors

Connector Comparison

ConnectorHierarchy PatternObject TypeProxiesInfo Fields
RevitFile → Level → Category → TypeRevitObjectRenderMaterial, Level, GroupReference Point Transform, Views
RhinoFile → Layer → SublayerGeometry, InstanceRenderMaterial, Color, Group, DefinitionViews
AutoCADFile → LayerGeometry, InstanceRenderMaterial, Color, Group, Definition-
Civil 3DFile → LayerCivil3dObject, Geometry, InstanceRenderMaterial, Color, Group, Definition, PropertySetDefinition-
NavisworksFile (flat) or Selection TreeNavisworksObjectRenderMaterial-
ArchiCADFile → Floor → TypeArchicadObjectRenderMaterial-
TeklaFile → TypeTeklaObjectRenderMaterial-
ETABSFile → Level → Design OrientationEtabsObjectSection, MaterialAnalysis Results
IFCProject → Site → Building → StoreyDataObjectRenderMaterial, Level-

Common Patterns

BIM Connectors (Revit, ArchiCAD, Tekla, ETABS)

  • Use DataObject extensions (RevitObject, ArchicadObject, etc.)
  • Organize by spatial hierarchy (Levels/Floors)
  • Include rich properties (parameters, quantities, classifications)
  • Use Level proxies for floor associations

CAD Connectors (Rhino, AutoCAD, Civil 3D)

  • Support standalone geometry objects
  • Organize by layers
  • Use Instance/Definition pattern for blocks/components
  • Include Color proxies for visual styling

Special Cases

  • Navisworks: Can flatten hierarchy or preserve selection tree
  • IFC: Follows IFC spatial structure (Project → Site → Building → Storey)
  • ETABS: Includes analysis results in Info section

Connector Page Structure

Each connector page follows this structure:
  1. Description - What the connector exports
  2. Hierarchy - How collections are organized
  3. Object Extensions - Connector-specific fields on DataObject
  4. Proxies - Which proxy types are used
  5. Info Fields - Model-level metadata
  6. Example - Canonical object example
  7. Invariants - Connector-specific rules and caveats

Using This Documentation

  1. Start with core concepts - Understand Models, Objects, Proxies first
  2. Review connector pages - Understand connector-specific behaviors
  3. Use traversal recipes - Apply traversal patterns to your use case
  4. Check examples - See working examples for common scenarios
No! Read only the connectors you’re working with. The core concepts apply to all connectors, and connector pages are reference material for when you need connector-specific details.
New connectors are added regularly. If you’re working with an unlisted connector, it still follows the same fundamental data model. Check the connector’s release notes or contact the Speckle team for connector-specific documentation.