Update IFTTT documentation (#22663)

This commit is contained in:
Danny Tsang 2022-05-09 12:06:22 +01:00 committed by GitHub
parent 89d9ba6154
commit e2d97a2970
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 33 additions and 23 deletions

View File

@ -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**.
<p class='img'>
<img src='/images/integrations/ifttt/finding_key.png' />
Property screen of the Maker Channel
</p>
![Property screen of the Maker Channel.](/images/integrations/ifttt/finding_key.png)
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
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
----- | -----
domain | `ifttt`
service | `trigger`
Service Data | `{"event": "EventName", "value1": "Hello World"}`
{% configuration_basic %}
event:
description: The name of the event to send.
required: true
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.
</p>
![Testing service.](/images/integrations/ifttt/testing_service.png)
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:
@ -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.
### 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*.
![Create applet.](/images/integrations/ifttt/create_applet.png)
<p class='img'>
<img src='/images/integrations/ifttt/setup_service.png' />
Choose "Webhooks" as service.
</p>
Choose *Webhooks* service.
![Choose "Webhooks" service.](/images/integrations/ifttt/setup_service.png)
Select *Receive a web request*.
![Receive a web request.](/images/integrations/ifttt/choose_webhook_trigger.png)
<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.
</p>
![You need to setup a unique trigger for each event you sent to IFTTT.](/images/integrations/ifttt/setup_trigger.png)
Add the *Then That* action. The below example sends a notification to the IFTTT mobile app and adds `value1` to the message:
![Example notification "then that" action.](/images/integrations/ifttt/setup_then_that.png)
{% raw %}

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 42 KiB