2026.10.4
Home ▸ Template functions

URL-encode a value: urlencode

The urlencode template function converts a dictionary of key-value pairs into a URL-encoded query string. This is Home Assistant’s override of the default urlencode filter, specifically designed to handle dictionaries for building HTTP request parameters.

This is useful when constructing URLs for REST commands, webhooks, or API calls from within your automationsAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] and scriptsA script is a saved list of steps that runs when you start it, for example, from a dashboard, with Assist, or from an automation. Unlike an automation, a script has no triggers, so it doesn’t start by itself. [Learn more]. For example, you might need to send data to an external service with properly encoded parameters, or build a query string for a webhook URL. The function ensures that special characters in your values are properly escaped so they are transmitted correctly.

Usage

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

As a function 
{{ urlencode({"name": "Living Room", "value": "23.5"}) }}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
name=Living+Room&value=23.5

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.

How to read a signature

Here is the signature of the round filter as an example:

round(
    value: Any,
    precision: int = 0,
    method: str = "common",
    default: Any,
) -> float | int | Any
  • round is the name of the function.
  • Between the parentheses are the parameters. Each parameter has a name, followed by a colon and the type of value the parameter expects. The type only tells you what kind of value to pass. For default: Any, you pass a value of any type, such as 0 or "unknown", not the word Any.
  • = 0 and = "common" are default values. You can leave out precision and method, and round uses these default values.
  • default has no =, but the parameter list marks default as optional. If you leave out default and round gets a value that isn’t a number, round raises an error.
  • -> shows the type of value the function returns.
  • Inside a signature, | means “or”. This function returns a decimal number, a whole number, or the value you passed as default.

round is a filter, so the first parameter, value, is the value before the |. For example, {{ 3.14159 | round(2) }} returns 3.14.

The types you’ll see most often:

  • str: text, such as "hello"
  • int: a whole number, such as 5
  • float: a decimal number, such as 3.14
  • bool: true or false
  • list: a list of values, such as [1, 2, 3]. list[str] is a list of texts.
  • dict: a set of keys and values, such as {"name": "Kitchen"}
  • datetime and timedelta: a date and time, and a duration. For details, refer to Dates and times.
  • None: no value
  • Any: any type of value

Some signatures use special forms:

  • *args means you can pass any number of values, separated by commas. For example, average(1, 2, 3).
  • value | name(...) means the function is a filter. The value before the | is passed to the filter as its first parameter. Some filter signatures, like the round example, show this value as the first parameter between the parentheses instead.
urlencode(
    value: dict,
) -> str

Function parameters

The following parameters can be provided to this function.

value map Required

A dictionary of key-value pairs to encode into a URL query string format. Keys and values are joined with = and pairs are separated with &.

Good to know

  • Spaces in values are encoded as +, not %20. Most servers accept both, but if you need %20 specifically, replace it afterwards.
  • Only accepts a dictionary. To encode a single string (for example, a URL path segment), handle it manually or use slugify where appropriate.

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.

Build a webhook URL with parameters

Construct a full URL with encoded query parameters for calling an external webhook.

TemplateA 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] 
{{
  "https://example.com/webhook?" ~ urlencode({
    "token": "abc123",
    "message": "Front door opened",
    "room": "Living Room"
  })
}}
Result (stringA piece of text, like a name, message, or entity ID. In templates, wrap strings in quotes, like "living_room" or "lights are on".) 
https://example.com/webhook?token=abc123&message=Front+door+opened&room=Living+Room

Send sensor data to an external service

Encode sensor values into a query string for use in a REST command.

ActionAn action makes Home Assistant do something, for example, turn on a light, send a notification, or activate a scene. Automations and scripts run a list of actions. [Learn more] 
action:
  - action: rest_command.send_data
    data:
      payload: >
        {{
          urlencode({
            "temperature": states("sensor.temperature"),
            "humidity": states("sensor.humidity"),
            "location": "home"
          })
        }}

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.

Tip

AI assistants like ChatGPT or Claude can also explain or fix templates when you describe what you want in plain language.

Related template functions

These functions work well alongside this one: