Convert URLs to HTML links: urlize

The urlize filter finds plain text URLs in a string and converts them into HTML anchor (<a>) tags. It recognizes URLs starting with http://, https://, and www.. This is useful when you have text that contains URLs and you want to turn them into links in an HTML context, such as a Markdown card or an HTML notification. For example, a sensorSensors return information about a thing, for instance the level of water in a tank. [Learn more] might report a URL as plain text, and you can use this filter to turn it into a real link.

Usage

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

{{ "Visit https://www.home-assistant.io for more info" | urlize }}

Visit <a href="https://www.home-assistant.io" rel="noopener">https://www.home-assistant.io</a> for more info

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 default are required.

urlize(
    value: str,
    trim_url_limit: int | None = None,
    nofollow: bool = False,
    target: str | None = None,
    rel: str | None = None,
) -> str

Function parameters

The following parameters can be provided to this function.

Shortening long URLs

Use trim_url_limit to shorten the displayed URL text while keeping the full link.

{{
  "See https://www.example.com/docs/templating/"
  | urlize(trim_url_limit=30)
}}

See <a href="https://www.example.com/docs/templating/"
rel="noopener">https://www.example.com/docs...</a>

Good to know

• Only URLs starting with http://, https://, or www. are recognized. Protocols like ftp:// or bare domains are left as plain text.
• The output contains HTML. Use it in contexts that render HTML, like Markdown cards or HTML-capable notifications.

Try it yourself

Ready to test this? Open Developer 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.

Turn a sensor URL into a link

Convert a URL reported by a sensor into a real link for a Markdown card.

{{ states("sensor.update_url") | urlize(target="_blank") }}

<a href="https://example.com/update" rel="noopener"
target="_blank">https://example.com/update</a>

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:

• URL-encode a value: urlencode - URL-encodes a dictionary of values for use in HTTP requests.

• Escape HTML characters: escape - Escapes HTML special characters in a string so they display as literal text.