Add webhook + IFTTT example (#16817)
* Add webhook + IFTTT example * Abort if not externally accessible * Abort on local url * Add description to create entry * Make body optional * Allow ifttt setup without config * Add tests * Lint * Fix Lint + Tests * Fix typing
This commit is contained in:
1 parent
06d959ed43
commit
f5632a5da5
13 files changed
+448
-91
No files matched your search
@@ -0,0 +1,94 @@
|
||||
"""Webhooks for Home Assistant.
|
||||
|
||||
For more details about this component, please refer to the documentation at
|
||||
https://home-assistant.io/components/webhook/
|
||||
"""
|
||||
import json
|
||||
import logging
|
||||
|
||||
from aiohttp.web import Response
|
||||
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.loader import bind_hass
|
||||
from homeassistant.auth.util import generate_secret
|
||||
from homeassistant.components.http.view import HomeAssistantView
|
||||
|
||||
DOMAIN = 'webhook'
|
||||
DEPENDENCIES = ['http']
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@callback
|
||||
@bind_hass
|
||||
def async_register(hass, webhook_id, handler):
|
||||
"""Register a webhook."""
|
||||
handlers = hass.data.setdefault(DOMAIN, {})
|
||||
|
||||
if webhook_id in handlers:
|
||||
raise ValueError('Handler is already defined!')
|
||||
|
||||
handlers[webhook_id] = handler
|
||||
|
||||
|
||||
@callback
|
||||
@bind_hass
|
||||
def async_unregister(hass, webhook_id):
|
||||
"""Remove a webhook."""
|
||||
handlers = hass.data.setdefault(DOMAIN, {})
|
||||
handlers.pop(webhook_id, None)
|
||||
|
||||
|
||||
@callback
|
||||
def async_generate_id():
|
||||
"""Generate a webhook_id."""
|
||||
return generate_secret(entropy=32)
|
||||
|
||||
|
||||
@callback
|
||||
@bind_hass
|
||||
def async_generate_url(hass, webhook_id):
|
||||
"""Generate a webhook_id."""
|
||||
return "{}/api/webhook/{}".format(hass.config.api.base_url, webhook_id)
|
||||
|
||||
|
||||
async def async_setup(hass, config):
|
||||
"""Initialize the webhook component."""
|
||||
hass.http.register_view(WebhookView)
|
||||
return True
|
||||
|
||||
|
||||
class WebhookView(HomeAssistantView):
|
||||
"""Handle incoming webhook requests."""
|
||||
|
||||
url = "/api/webhook/{webhook_id}"
|
||||
name = "api:webhook"
|
||||
requires_auth = False
|
||||
|
||||
async def post(self, request, webhook_id):
|
||||
"""Handle webhook call."""
|
||||
hass = request.app['hass']
|
||||
handlers = hass.data.setdefault(DOMAIN, {})
|
||||
handler = handlers.get(webhook_id)
|
||||
|
||||
# Always respond successfully to not give away if a hook exists or not.
|
||||
if handler is None:
|
||||
_LOGGER.warning(
|
||||
'Received message for unregistered webhook %s', webhook_id)
|
||||
return Response(status=200)
|
||||
|
||||
body = await request.text()
|
||||
try:
|
||||
data = json.loads(body) if body else {}
|
||||
except ValueError:
|
||||
_LOGGER.warning(
|
||||
'Received webhook %s with invalid JSON', webhook_id)
|
||||
return Response(status=200)
|
||||
|
||||
try:
|
||||
response = await handler(hass, webhook_id, data)
|
||||
if response is None:
|
||||
response = Response(status=200)
|
||||
return response
|
||||
except Exception: # pylint: disable=broad-except
|
||||
_LOGGER.exception("Error processing webhook %s", webhook_id)
|
||||
return Response(status=200)
|
||||
Reference in new issue
Block a user