Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ifttt Namespace Reference

Namespaces

 alarm_control_panel
 
 config_flow
 
 const
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None handle_webhook (HomeAssistant hass, str webhook_id, web.Request request)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 async_remove_entry = config_entry_flow.webhook_async_remove_entry
 
string ATTR_EVENT = "event"
 
string ATTR_TARGET = "target"
 
string ATTR_VALUE1 = "value1"
 
string ATTR_VALUE2 = "value2"
 
string ATTR_VALUE3 = "value3"
 
string CONF_KEY = "key"
 
 CONFIG_SCHEMA
 
string EVENT_RECEIVED = "ifttt_webhook_received"
 
string SERVICE_PUSH_ALARM_STATE = "push_alarm_state"
 
string SERVICE_TRIGGER = "trigger"
 
 SERVICE_TRIGGER_SCHEMA
 

Detailed Description

Support to trigger Maker IFTTT recipes.

Function Documentation

◆ async_setup()

bool homeassistant.components.ifttt.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the IFTTT service component.

Definition at line 59 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.ifttt.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Configure based on config entry.

Definition at line 122 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.ifttt.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 130 of file __init__.py.

◆ handle_webhook()

None homeassistant.components.ifttt.handle_webhook ( HomeAssistant  hass,
str  webhook_id,
web.Request   request 
)
Handle webhook callback.

Definition at line 98 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.ifttt._LOGGER = logging.getLogger(__name__)
private

Definition at line 24 of file __init__.py.

◆ async_remove_entry

homeassistant.components.ifttt.async_remove_entry = config_entry_flow.webhook_async_remove_entry

Definition at line 136 of file __init__.py.

◆ ATTR_EVENT

string homeassistant.components.ifttt.ATTR_EVENT = "event"

Definition at line 28 of file __init__.py.

◆ ATTR_TARGET

string homeassistant.components.ifttt.ATTR_TARGET = "target"

Definition at line 29 of file __init__.py.

◆ ATTR_VALUE1

string homeassistant.components.ifttt.ATTR_VALUE1 = "value1"

Definition at line 30 of file __init__.py.

◆ ATTR_VALUE2

string homeassistant.components.ifttt.ATTR_VALUE2 = "value2"

Definition at line 31 of file __init__.py.

◆ ATTR_VALUE3

string homeassistant.components.ifttt.ATTR_VALUE3 = "value3"

Definition at line 32 of file __init__.py.

◆ CONF_KEY

string homeassistant.components.ifttt.CONF_KEY = "key"

Definition at line 34 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.ifttt.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(DOMAIN): vol.Schema(
4  {vol.Required(CONF_KEY): vol.Any({cv.string: cv.string}, cv.string)}
5  )
6  },
7  extra=vol.ALLOW_EXTRA,
8 )

Definition at line 49 of file __init__.py.

◆ EVENT_RECEIVED

string homeassistant.components.ifttt.EVENT_RECEIVED = "ifttt_webhook_received"

Definition at line 26 of file __init__.py.

◆ SERVICE_PUSH_ALARM_STATE

string homeassistant.components.ifttt.SERVICE_PUSH_ALARM_STATE = "push_alarm_state"

Definition at line 36 of file __init__.py.

◆ SERVICE_TRIGGER

string homeassistant.components.ifttt.SERVICE_TRIGGER = "trigger"

Definition at line 37 of file __init__.py.

◆ SERVICE_TRIGGER_SCHEMA

homeassistant.components.ifttt.SERVICE_TRIGGER_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_EVENT): cv.string,
4  vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [cv.string]),
5  vol.Optional(ATTR_VALUE1): cv.string,
6  vol.Optional(ATTR_VALUE2): cv.string,
7  vol.Optional(ATTR_VALUE3): cv.string,
8  }
9 )

Definition at line 39 of file __init__.py.