Home Assistant Unofficial Reference 2024.12.1
__init__.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.webhook.WebhookView
 

Namespaces

 homeassistant.components.webhook
 

Functions

str homeassistant.components.webhook.async_generate_id ()
 
str homeassistant.components.webhook.async_generate_path (str webhook_id)
 
str homeassistant.components.webhook.async_generate_url (HomeAssistant hass, str webhook_id, bool allow_internal=True, bool allow_external=True, bool|None allow_ip=None, bool|None prefer_external=True)
 
Response homeassistant.components.webhook.async_handle_webhook (HomeAssistant hass, str webhook_id, Request|MockRequest request)
 
None homeassistant.components.webhook.async_register (HomeAssistant hass, str domain, str name, str webhook_id, Callable[[HomeAssistant, str, Request], Awaitable[Response|None]] handler, *bool|None local_only=False, Iterable[str]|None allowed_methods=None)
 
bool homeassistant.components.webhook.async_setup (HomeAssistant hass, ConfigType config)
 
None homeassistant.components.webhook.async_unregister (HomeAssistant hass, str webhook_id)
 
None homeassistant.components.webhook.websocket_handle (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.webhook.websocket_list (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
 

Variables

 homeassistant.components.webhook._LOGGER = logging.getLogger(__name__)
 
 homeassistant.components.webhook.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
 
tuple homeassistant.components.webhook.DEFAULT_METHODS = (METH_POST, METH_PUT)
 
string homeassistant.components.webhook.DOMAIN = "webhook"
 
tuple homeassistant.components.webhook.SUPPORTED_METHODS = (METH_GET, METH_HEAD, METH_POST, METH_PUT)
 
string homeassistant.components.webhook.URL_WEBHOOK_PATH = "/api/webhook/{webhook_id}"