Skip to content

Require local_only to be a boolean on webhook #169296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edenhaus merged 2 commits into from
Apr 28, 2026
+10 −13
Merged

Require local_only to be a boolean on webhook #169296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41df341
Require local_only to be a boolean on webhook
edenhaus Apr 27, 2026
83bbe12
Add comment
edenhaus Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions homeassistant/components/webhook/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def async_register(
webhook_id: str,
handler: Callable[[HomeAssistant, str, Request], Awaitable[Response | None]],
*,
local_only: bool | None = False,
local_only: bool = False,
allowed_methods: Iterable[str] | None = None,
) -> None:
"""Register a webhook."""
Expand All @@ -60,6 +60,13 @@ def async_register(
f"Unexpected method: {allowed_methods.difference(SUPPORTED_METHODS)}"
)

if not isinstance(local_only, bool):
Comment thread
edenhaus marked this conversation as resolved.
# Previously it was valid to pass None for local_only and it was treated as False
# with a deprecation warning. In case a custom component is still passing None,
# we want to raise an error instead of silently treating it as False as the
# deprecation period has ended and the message was removed.
raise TypeError("local_only must be a boolean")
Comment thread
edenhaus marked this conversation as resolved.

Comment thread
edenhaus marked this conversation as resolved.
handlers[webhook_id] = {
"domain": domain,
"name": name,
Expand Down Expand Up @@ -159,7 +166,7 @@ async def async_handle_webhook(
)
return Response(status=HTTPStatus.METHOD_NOT_ALLOWED)

if webhook["local_only"] in (True, None):
if webhook["local_only"]:
is_local = not (is_cloud_connection(hass) or request.remote is None)

if is_local:
Expand All @@ -176,17 +183,7 @@ async def async_handle_webhook(

if not is_local:
_LOGGER.warning("Received remote request for local webhook %s", webhook_id)
if webhook["local_only"]:
return Response(status=HTTPStatus.OK)
if not webhook.get("warned_about_deprecation"):
webhook["warned_about_deprecation"] = True
_LOGGER.warning(
"Deprecation warning: "
"Webhook '%s' does not provide a value for local_only. "
"This webhook will be blocked after the 2023.11.0 release. "
"Use `local_only: false` to keep this webhook operating as-is",
webhook_id,
)
return Response(status=HTTPStatus.OK)

try:
response: Response | None = await webhook["handler"](hass, webhook_id, request)
Expand Down