IFTTT - Version 2.2.0#

Module Summary#

Integrates with IFTTT to send and receive events using their Webhooks Service.

Module Status#

Note: This is a beta version, due to changes in the working of the module and bug fixes. Testing is highly recommended before being used on a project and feedback is appreciated.

Note: Due to some changes in the way the module is configured in Designer, updating to this module from an older version may require reconfiguration of your show file. Keep a backup of your previous file, should you need to revert to, or reference it. If you have already updated and confirmed the warning, you can undo the change and update when you are in a position to do so.

If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.

Release Notes#

Version 2.2#

  •  Updated documentation.

Version 2.1#

  •  Bug fixes.

  •  Updated action and trigger names.

  •  Updated action and trigger descriptions.

  •  Added Extended Logging property for detailed diagnostic logging.

  •  Updated documentation.

Version 2.0#

  •  Added status variables to display outgoing and incoming messages.

Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.

Configuration#

The example in this documentation will send an event to IFTTT (the Send IFTTT Event action in Designer) and then receive an event from IFTTT (the IFTTT Event Received trigger in Designer). This is purely for demonstrational purposes and the if-this and the then-thats can be configured to use any of the other IFTTT applets.

Set up of an IFFTT event trigger:#

  1. Go to IFTTT.com.

  2. Login (or create an account).

  3. Click Create in the top right of the page.

  4. Click the If This [Add] button.

  5. Search for and select Webhooks.

  6. Click Receive a web request.

  7. Give the event a name. This name must match the Event to Trigger in Designer and should be descriptive of the event, in this example, “action_from_controller_to_ifttt”. Click Create trigger.

Setup of an IFTTT event:#

  1. Click Then That [Add] button.

  2. Search for and select Webhooks.

  3. Click Make a web request.

  4. Configure the request properties as follows:

  • URL: http://public_ip_address:8000

  • Method: POST

  • Content Type: application/json

  • Body: {“event”:trigger_from_ifttt_to_controller,”1”:value1, “2”:value2, “3”:myvalue3}

Note: The public_ip_address is the address your router uses to connect to the Internet and not the controller’s local IP address. The default port and the port in this example is 8000. This must be set in the Incoming Port in the instance properties. You may need to set up a port forwarding rule on your router to direct the IFTTT messages to the controller.

The first key:value pair must always be the event name. When setting the data variables, the keys must be in number format and must match the trigger variable indexes you’d expect to see on the controller. Keys and values can be surrounded by quotation marks, but these will be removed when converted to trigger variables.

Note: Colons, semi-colons, square brackets and slashes are not supported. Non-alpha-numeric characters allowed in the event name and values are spaces and _ - . , + % ! @ £ $ ^ & * ? ( ) < >

  1. Click Create Action and Continue.

  2. You may want to specify an Applet Title (just a description) or you can leave it as the default.

  3. Click Finish.

To obtain the key:#

  1. Click your user in the top right hand corner.

  2. Choose My Services and click Webhooks

  3. Select the Webhooks service

  4. Click Documentation

  5. Your key will be displayed at the top of the page. Copy this to the Key and paste it to the Key text box in instance properties.

Operation#

Create a Send IFTTT Event and IFTTT Event Received trigger (see below). If configured correctly, once the Send IFTTT Event action has been called (for example, from a Startup trigger), IFTTT will receive the event and then send another Webhook event back to the controller to fire the IFTTT Event Received trigger.

Instance Properties#

Enter the Key retrieved from the setup steps above.

The Incoming Port is used for receiving events and should match the port specified when creating the webhook event. You may need to set up a port forwarding rule on your router to direct the IFTTT messages to the controller.

Checking the Extended Logging checkbox will provide more detailed log messages for IFTTT messages, triggers and actions.

Triggers#

IFTTT Event Received#

Fires when a Webhook event is received from IFTTT and the Event property matches the received event name. Any variables included in the Webhook message will be passed into the trigger as variables, where the numerical key is the variable number.

Using the example above, create and IFTTT Event Received trigger and set the Event name to “trigger_from_ifttt_to_controller” (without the quotation marks).

Actions#

Send IFTTT Event#

Sends a Webhook event to IFTTT to trigger an IFTTT event.

Set the Event to Trigger property that will match the event name in the IFTTT trigger. In the example above, “action_from_controller_to_ifttt” (without the quotation marks).

Data 1, Data 2, and Data 3are optional fields should you wish to send variables along with the event.

Trigger Variables#

The keys received from the IFTTT event must be in number format and must match the trigger variable indexes you’d expect to see on the controller. Keys and values can be surrounded by quotation marks, but these will be removed when converted to trigger variables.

Support#

If you encounter any issues with this module, please contact our support team.