Get a specific repair issue: issue

The issue template function looks up a specific repair issue by its domain and issue ID. Repair issues are problems that Home Assistant has detected and flagged for your attention. This function returns the issue as a dictionary if it exists and is active, or None if no such issue is found.

This is useful when you want to check whether a specific known issue is currently active. For example, you might want to monitor whether a particular integration has a configuration problem, display the status of a specific repair on your dashboard, or trigger an automationAutomations in Home Assistant allow you to automatically respond to things that happen in and around your home. [Learn more] only when a specific issue is present.

Usage

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

{{ issue("hue", "deprecated_bridge") }}

{'domain': 'hue', 'issue_id': 'deprecated_bridge', 'severity': 'warning', ...}

{{ "deprecated_bridge" | issue("hue") }}

{'domain': 'hue', 'issue_id': 'deprecated_bridge', 'severity': 'warning', ...}

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.

issue(
    domain: str,
    issue_id: str,
) -> dict[str, Any] | None

Function parameters

The following parameters can be provided to this function.

Checking if an issue exists

Since the function returns None when the issue is not found, you can use it directly in conditions.

{% if issue("hue", "deprecated_bridge") %}
  Hue bridge issue is active
{% else %}
  No Hue bridge issue
{% endif %}

Hue bridge issue is active

Good to know

• Returns None when the issue does not exist or has been dismissed, so checks like if issue(...) work directly.
• Only active (non-ignored) issues are returned.

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.

Display issue severity

Look up a specific issue and show its severity level.

{% set hue_issue = issue("hue", "deprecated_bridge") %}
{% if hue_issue %}
  Hue issue severity: {{ hue_issue.severity }}
{% else %}
  No issue found
{% endif %}

Hue issue severity: warning

Conditional notification based on issue

Send a notification only when a specific repair issue is active.

action:
  - condition: template
    value_template: '{{ issue("zwave", "config_error") is not none }}'
  - action: notify.mobile
    data:
      message: "Z-Wave configuration error detected. Check repairs."

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:

• Get all repair issues: issues - Returns all active repair issues currently open in Home Assistant.