Automations

Home Assistant Blueprints: How to Import and Use Community Automations

Import a Home Assistant blueprint from a URL, create automations from it, keep it updated, and review its YAML for safety before you run community blueprints.

On this page
  1. What a blueprint is and is not
  2. Built-in blueprints to try first
  3. Import a blueprint
  4. Create an automation from a blueprint
  5. Where the files live
  6. Updates: re-import, edit and take control
  7. Review before you use it
  8. Compatibility
  9. Deleting a blueprint
  10. Where to find more

A blueprint is a reusable template for an automation or script. It has inputs, such as which motion sensor and which light to use. You import a blueprint once, then create as many automations from it as you need, each with its own inputs.

What a blueprint is and is not

A blueprint is a YAML file with a description and a list of inputs. It is not an integration, and it does not add support for a device. If Home Assistant cannot work with your device, a blueprint will not change that. It only works with devices Home Assistant already knows about.

Importing a blueprint does not create an automation. You still create one from it.

Built-in blueprints to try first

Home Assistant includes blueprints you can use without importing anything. Examples include Motion-activated Light and Zone Notification, which are automations, and Confirmable Notification, which is a script.

Import a blueprint

  1. Go to Settings > Automations & Scenes > Blueprints.
  2. Select Import Blueprint and paste the URL.
  3. Check the preview, and then import it.

Accepted URLs include a GitHub file, a GitHub Gist, a Home Assistant community forum post, and a raw YAML link. Many forum posts have a My Home Assistant badge. Selecting it opens the import dialog with the address already filled in.

Community blueprints are often listed in the Blueprints Exchange category of the Home Assistant community forum. Blueprint directories also list community templates. Check the source of any template before you import it.

Create an automation from a blueprint

Open the imported blueprint and select Create automation. Fill in its inputs. Inputs use selectors, so you pick a device, entity, number or time from a list instead of typing an entity ID. Then save the automation.

Where the files live

Blueprint files are stored under config/blueprints/, in folders named for the domain and the author, such as config/blueprints/automation/<author>/<name>.yaml. If you add a file by hand, reload automations or restart Home Assistant so it appears.

Updates: re-import, edit and take control

  • Editing a blueprint file changes every automation that uses it, once you reload.
  • Re-import fetches the latest version from the source URL. It overwrites any local edits you made to the blueprint file.
  • Take control detaches one automation from its blueprint and turns it into a normal automation you can edit freely. Later changes to the blueprint no longer apply to it.

Community blueprints do not update themselves. Check the source for new versions.

Review before you use it

Read the YAML before you import or run a blueprint. A blueprint can call any action, including actions that unlock doors or open garage doors. Check:

  • which triggers it uses, and whether they are narrow enough for your setup
  • which actions it calls, and whether any of them control locks, alarms or doors
  • whether it sends data to a web address or notifications to a destination you do not recognise
  • whether it depends on a specific integration, such as ZHA or Zigbee2MQTT, that you do not use

Test a new blueprint with a non-critical device first.

Compatibility

Some blueprints require a minimum Home Assistant version, which the min_version setting states. Device-specific blueprints, such as those for a particular remote, only work with the integration they name.

Deleting a blueprint

You cannot delete a blueprint while any automation still uses it. Remove or change those automations first.

Where to find more

Start with the Blueprints Exchange on the Home Assistant community forum, and with community blueprint directories. Read each template’s description and comments before you import it.

For how triggers, conditions and actions fit together in an automation, read the automations and actions guide. For a worked example of a motion blueprint, see how to turn on lights with a motion sensor. If an imported automation never fires, see why your automation isn’t triggering. Notification templates are covered in the notifications guide.

The complete guide to automations

Home Assistant Automations: Services, Actions and REST Commands
Read the guide

Keep exploring

Guides from other topics

All topics →