Update IFTTT documentation (#22663)
@ -62,11 +62,7 @@ ifttt:
|
|||||||
```
|
```
|
||||||
|
|
||||||
`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.
|
`key` is your API key which can be obtained by viewing the **Settings** of the [Webhooks applet](https://ifttt.com/services/maker_webhooks/settings). It's the last part of the URL (e.g., https://maker.ifttt.com/use/MYAPIKEY) you will find under **My Applets** > **Webhooks** > **Settings**.
|
||||||
|

|
||||||
<p class='img'>
|
|
||||||
<img src='/images/integrations/ifttt/finding_key.png' />
|
|
||||||
Property screen of the Maker Channel
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Once you have added your key to your `configuration.yaml` file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.
|
Once you have added your key to your `configuration.yaml` file, restart your Home Assistant instance. This will load up the IFTTT integration and make a service available to trigger events in IFTTT.
|
||||||
|
|
||||||
@ -88,18 +84,29 @@ ifttt:
|
|||||||
|
|
||||||
### Testing your trigger
|
### Testing your trigger
|
||||||
|
|
||||||
You can use **Developer Tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant sidebar, click on Developer Tools, and then the **Services** tab. Fill in the following values:
|
You can use **Developer Tools** to test your [Webhooks](https://ifttt.com/maker_webhooks) trigger. To do this, open the Home Assistant sidebar, click on **Developer Tools** -> **Services** tab. Select `IFTTT: Trigger` as the service and fill in the following values:
|
||||||
|
|
||||||
Field | Value
|
{% configuration_basic %}
|
||||||
----- | -----
|
event:
|
||||||
domain | `ifttt`
|
description: The name of the event to send.
|
||||||
service | `trigger`
|
required: true
|
||||||
Service Data | `{"event": "EventName", "value1": "Hello World"}`
|
type: string
|
||||||
|
value1:
|
||||||
|
description: Generic field to send data via the event.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
value2:
|
||||||
|
description: Generic field to send data via the event.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
value3:
|
||||||
|
description: Generic field to send data via the event.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
{% endconfiguration_basic %}
|
||||||
|
|
||||||
<p class='img'>
|
|
||||||
<img src='/images/integrations/ifttt/testing_service.png' />
|
|
||||||
When your screen looks like this, click the 'call service' button.
|
When your screen looks like this, click the 'call service' button.
|
||||||
</p>
|

|
||||||
|
|
||||||
By default, the trigger is sent to all the API keys from `configuration.yaml`. If you
|
By default, the trigger is sent to all the API keys from `configuration.yaml`. If you
|
||||||
want to send the trigger to a specific key use the `target` field:
|
want to send the trigger to a specific key use the `target` field:
|
||||||
@ -112,19 +119,22 @@ Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_
|
|||||||
|
|
||||||
The `target` field can contain a single key name or a list of key names.
|
The `target` field can contain a single key name or a list of key names.
|
||||||
|
|
||||||
### Setting up a recipe
|
### Setting up an applet
|
||||||
|
|
||||||
Press the *New applet* button and search for *Webhooks*.
|
Press the *Create* button and *Add* on **If This**. Search for *Webhooks*.
|
||||||
|

|
||||||
|
|
||||||
<p class='img'>
|
Choose *Webhooks* service.
|
||||||
<img src='/images/integrations/ifttt/setup_service.png' />
|

|
||||||
Choose "Webhooks" as service.
|
|
||||||
</p>
|
Select *Receive a web request*.
|
||||||
|

|
||||||
|
|
||||||
<p class='img'>
|
|
||||||
<img src='/images/integrations/ifttt/setup_trigger.png' />
|
|
||||||
You need to setup a unique trigger for each event you sent to IFTTT.
|
You need to setup a unique trigger for each event you sent to IFTTT.
|
||||||
</p>
|

|
||||||
|
|
||||||
|
Add the *Then That* action. The below example sends a notification to the IFTTT mobile app and adds `value1` to the message:
|
||||||
|

|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
|
BIN
source/images/integrations/ifttt/choose_webhook_trigger.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
source/images/integrations/ifttt/create_applet.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
source/images/integrations/ifttt/setup_then_that.png
Normal file
After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 42 KiB |