Randomly shuffle a list: shuffle

The shuffle template function takes a list and returns a new list with the items in a random order. Every time it is evaluated, the order can be different, giving you a way to introduce randomness into your templatesA template is an automation definition that can include variables for the action or data from the trigger values. This allows automations to generate dynamic actions. [Learn more].

This is useful when you want to pick a random item from a collection or display things in a random order. For example, you might shuffle a list of greetings to get a different welcome message each time, randomize the order of automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] to stagger their execution, or select a random playlist. You can also pass a seed value to get a reproducible shuffle, which can be helpful for testing or when you want the same random order for a given input.

Usage

Here’s how to use this template function. Copy any example and adjust it to your setup.

{{ shuffle(["a", "b", "c", "d"]) }}

["c", "a", "d", "b"]

{{ ["a", "b", "c", "d"] | shuffle }}

["c", "a", "d", "b"]

Function signature

The signature is a technical summary of this template function. It shows the name of the function, the values (called parameters) it accepts, and what type of data each parameter expects (for example, a piece of text or a number).

Function parameters that have a = with a value after them are optional. If you leave them out, the default value shown is used automatically.

Function parameters without a = are usually required. A few optional parameters have no default value, so the signature shows them without a = as well. To check whether a parameter is required, look at the parameter list below the signature. Each parameter is marked as Required or Optional.

The most common optional parameter without a default value is default. The default parameter sets the value a function returns when the function can’t produce a result, for example, when float gets text that isn’t a number. If you leave out default, there is no fallback value, so most functions raise an error and the template fails. The parameter list of each function says what happens. If you set default, the function returns your value instead.

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any

shuffle(
    *args: list | Any,
    seed: Any = None,
) -> list

Function parameters

The following parameters can be provided to this function.

Reproducible shuffle with a seed

Pass a seed to get the same shuffled order each time. This is useful for testing or when you want consistent randomization based on a known value.

{{ shuffle(["a", "b", "c", "d"], seed="fixed") }}

["b", "d", "a", "c"]

Good to know

• A new random order is returned each time the template renders. Template entities using shuffle re-evaluate and change often.
• Pass a seed to get a reproducible order, which is useful for testing or stable randomness tied to a date.

Try it yourself

Ready to test this? Open Settings > Tools > Template, paste the example into the Template editor, and watch the result update on the right. Edit the values to see how the function adapts to your own entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more].

More examples

Real scenarios where this function comes up in automations and templates. Copy any example and adapt it to your setup.

Pick a random greeting

Shuffle a list and take the first item to select a random value.

{{ shuffle(["Hello!", "Hi there!", "Welcome!", "Good day!"]) | first }}

Welcome!

Shuffle individual arguments

You can also pass items as separate arguments instead of a list.

{{ shuffle("red", "green", "blue") }}

["green", "red", "blue"]

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with your template and expected result, or share on our subreddit /r/homeassistant.

Related template functions

These functions work well alongside this one:

• Flatten nested lists: flatten - Flattens nested lists into a single flat list.

• Convert to set: set - Converts an iterable to a set, removing duplicate values.