scaffold a custom home assistant integration with a manifest.json and a ui config flow

domain: developers.home-assistant.io · 5 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Run the python3 -m script.scaffold config_flow (or config_flow_discovery) tool in a Home Assistant core dev environment to generate integration boilerplate.
  2. Fill in manifest.json fields: domain, name, codeowners, documentation, iot_class, requirements, and set config_flow: true to enable UI setup.
  3. Implement a config_flow.py that subclasses ConfigFlow and defines async steps (e.g. async_step_user) for each UI screen.
  4. Define the field labels/descriptions for each config flow step in strings.json (and translations if needed).
  5. Test the integration by adding it through Settings > Devices & Services in the UI and confirming the config flow screens render correctly.

Known gotchas

Related routes

Configure ESPHome with native API and integrate a custom sensor device with Home Assistant using device substitutions and packages
esphome.io · 6 steps · unrated
Integrate a custom device into Home Assistant using MQTT discovery so it appears automatically without manual YAML configuration
home-assistant.io · 6 steps · unrated
build a custom integration using the shortcuts salon software restful api
shortcutssoftware.io · 5 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans