Welcome to collective.ifttt!

collective.ifttt is a Plone addon which enables any Plone site to play in the IFTTT (pronounced /ɪft/) ecosystem by allowing you to create IFTTT applets at ifttt.com.

Below are a few examples of using IFTTT with Plone sites.

• If a news item is published, then tweet about it or post it on Facebook.
• If an event is published, then add it to my calendar.
• If new users sign up for an event, then add them to a Slack channel.
• If content changes, then record who edited it in a Google spreadsheet.

Contents

This documentation will teach you how to use collective.ifttt to create IFTTT applets for Plone sites. We’ll start with setting up a Plone RSS feed, which can be used on IFTTT without doing anything special. In the sections after that you will learn how to set up your IFTTT secret key and create IFTTT triggers, so you can create more customized applets.

What is IFTTT?

ifttt.com - If This Then That, also known as IFTTT (pronounced /ɪft/) - is a free web-based service to create chains of simple conditional statements, called applets. These applets can perform a configured action in response to a trigger. Triggers and actions are web services provided by platforms such as Facebook, Pinterest, Youtube, Spotify - and now, Plone sites.

Below are a few examples of IFTTT applets for better understanding:

• If a video is liked on Youtube, then save the video details in Evernote
• If a profile picture gets changed on Facebook, then update the same profile picture on Twitter
• If I’m tagged in a photo on Facebook, then save it to my phone gallery
• If I receive an email about a new Twitter follower in my Gmail inbox, then tweet the new follower a welcome message
• If NASA posts a new astronomy picture of the day, then add it to my screensaver gallery.
• Email me about Top Apps that have become FREE in the Apple App Store.
• Automatically unmute my Android phone when I get back home.
• Add a Spotify song from a liked YouTube Video.

collective.ifttt is an addon which enables any Plone site to play in the IFTTT ecosystem by allowing you to create IFTTT applets.

Below are a few examples of using IFTTT with Plone sites.

• If a news item is published, then tweet about it or post it on Facebook.
• If an event is published, then add it to my calendar.
• If new users sign up for an event, then add them to a Slack channel.
• If content changes, then record who edited it in a Google spreadsheet.

Introduction to IFTTT Applets

What is an Applet?

An Applet connects two or more apps or devices together. It enables you to do something that those apps or devices couldn’t do on their own.

Applets are composed of triggers and actions. Triggers tell an Applet to start, and actions are the end result of an Applet run. To use an Applet, you’ll need a free IFTTT account. Then you need to connect your apps and devices to IFTTT.

Follow this link for easy creation of an IFTTT Applet.

Enabling RSS Feeds On Plone Sites

Introduction

Plone can generate RSS feeds from folderish content types like folders and collections. First you must enable syndication on your site so that RSS feeds will be generated. Then you can go to the collection or folder you want to use as a feed and adjust its syndication settings.

If you want to aggregate a particular set of content to an RSS feed, you can create a collection content item for that purpose. You can choose what content types to aggregate and filter by fields such as labels, dates, location or language. Collections are language aware so this works correctly on multilingual sites.

Once you have an RSS feed you can use it on IFTTT without doing anything special. (No secret key, no IFTTT trigger needed.)

Below are the steps to create an example RSS Feed on a Plone site. You can tweak the configuration to meet your requirements and make different kinds of RSS feeds given the flexibility of collections.

Enabling Syndication

Step 1

Go to Site Setup.

Step 2

Select Syndication under General.

Step 3

Select the following and save:

1. Allowed
2. Search RSS enabled (if you want to be able to use search results as feeds)
3. Show settings button (this will enable the Syndication tab on the edit bar of folders and collections)
4. Show feed link (this allows you to show an RSS link on the folder or collection)
5. Save

You may optionally include author information and adjust the maximum number of feed items.

Creating a Collection to Use as an RSS Feed

Step 1

Go to the site root. (This is a special type of object, so the Syndication tab will not show on the edit bar here, like it will on all other folders.)

Step 2

Add a new collection.

Step 3

Configure your collection. The configuration explained below will aggregate all available published content. This can be tweaked to suit your own requirements.

1. Update Title to “Plone Site - RSS feed” or any other suitable name.
2. For Select Criteria, choose Review State as Published. (Otherwise unpublished items will show in your feed and people will get an error when they click on that URL.)
3. For Sort On choose Effective date and check Reversed Order.

Step 4

On the Settings tab check Exclude from navigation if you want to make it disappear from the navigation tree.

Save your new collection.

Step 5

If the collection’s content seems to be right, publish it using the State menu on the edit bar.

Viewing Your RSS Feed

Step 1

Your RSS feed can be viewed by appending /RSS to your collection’s (or folder’s) URL - something like /path_to_collection/RSS. (Note that this is case sensitive, “/rss” will not work.) For our example the URL to the RSS feed is http://localhost:8080/Plone/plone-site-rss-feed/RSS

Step 2

To show a link to the RSS feed on a collection or folder, enable it on the edit bar’s Syndication tab as shown below. This is an optional step - many sites choose not to show these feed links because it might confuse their users.

Now your RSS feed is ready to be used in an IFTTT applet. You can test it by copy-pasting the RSS URL into an RSS Reader, like feeder.co or Mozilla Reader.

Using Plone RSS Feeds in IFTTT Applets

To learn how to create an IFTTT applet using an RSS feed, follow the demonstration below.

This applet will add a new row on Google Spreadsheet each time an RSS Feed get publishes. However, one may teak this configuration based on user requirement.

---

• Signup at free IFTTT account.
• Navigate to your Username in the upper right corner
• Select New Applet from the dropdown menu
• Click the blue ‘this’ text
• Search rss in search box. And select RSS Feed

• Choose New feed item
• Fill RSS feed url in the given space. And click Create Trigger

• Click the blue ‘that’ text
• Choose Google Sheets as Action Service

• Choose Add row to spreadsheet
• Configure the form based on required tweaks and hit Create Action

• Click Finish

Hurrah!! We successfully created our IFTTT Applet.

Now Every time an RSS get publishes, it will automatically be added as a new row to our Google Spreadsheet.

Configuring a Plone Site with an IFTTT Secret Key

IFTTT supports push notification, which can be leveraged to get instant notifications from a Plone site. To do that you need to configure the Plone site with your IFTTT secret key.

Follow the steps below to get your IFTTT secret key and save it in your Plone site.

Obtaining an IFTTT Secret Key

1. Go to ifttt.com and sign up for an account.
2. At the top click on ‘Search’ and find ‘Maker’. (Update: this is now named ‘Webhook’.)

3. Click the ‘Connect’ button to create a Maker (Webhook) channel.

4. Click on the gear icon (Settings) on the top-right of the Maker (Webhook) channel to view your key.

Saving an IFTTT Secret Key in Plone

1. Go to Site Setup

2. Select IFTTT Settings under Add-on Configuration

3. Copy your key to the Secret Key field and click Save.

Content Trigger

This document will guide admins to add an IFTTT “Content Trigger” to any folder on their site that will send a trigger to IFTTT when content at or below the current path is published. This will allow them to create IFTTT applets to, for example, email, tweet, or Facebook post about the content.

Pre-requisite: IFTTT secret key should be configured as discribed at Configuring a Plone Site with an IFTTT Secret Key.

Follow the steps given below to Add an IFTTT Content Trigger onto any folder.

1. Traverse to folder on which you desire to apply IFTTT content trigger.
2. From IFTTT menu select Add Ifttt Content Trigger

3. Fill the given form with required values and click Add

4. Tada, trigger has been applied on your folder!!

Behind the Scenes

This section details all jobs performed behind the scenes after form gets filled.

1. A new Content Rule is dynamically created and assigned with requested conditions and IFTTT event name for this folder and it’s sub-folder.

To know more about content rules, follow this link.

2. Rules menu on left bar will show you all content rules applied on this folder.

Content Rule Conditions

1. Default Trigger condition for this content rule is: Workflow state changed

2. Default contition for this content rule is: Workflow State as published

Data sent to IFTTT applet

In the data sent to IFTTT, following values will be dynamically included (for which content on the site this content rule triggers):

• Title
• Absolute_url
• Description

Content and User Trigger

This document will guide admins to add an IFTTT “Content and User Trigger” to any folder on their site that will send a trigger to IFTTT when content at or below the current path is edited, including the information of who changed it. This will allow them to create IFTTT applets to, for example, log the edit information to Slack or a Google spreadsheet.

Pre-requisite: IFTTT secret key should be configured as discribed at Configuring a Plone Site with an IFTTT Secret Key.

Follow the steps given below to Add an IFTTT Content Trigger onto any folder.

1. Traverse to folder on which you desire to apply IFTTT content trigger.
2. From IFTTT menu select Add Ifttt User Trigger

3. Fill the given form with required values and click Add

4. Tada, trigger has been applied on your folder!!

Behind the Scenes

This section details all jobs performed behind the scenes after form gets filled.

1. A new Content Rule is dynamically created and assigned with requested conditions and IFTTT event name for this folder and it’s sub-folder.

To know more about content rules, follow this link.

2. Rules menu on left bar will show you all content rules applied on this folder.

Content Rule Conditions

Default Trigger condition for this content rule is: Object Modified

Data sent to IFTTT applet

In the data sent to IFTTT, following values will be dynamically included (for which content on the site this content rule triggers):

• Title
• Absolute_url
• Username who modified the content

Event Trigger

This document will guide admins to add an IFTTT “Event Trigger” to any folder on their site that will send a trigger to IFTTT when an event at or below the current path is published. This will allow them to create IFTTT applets to, for example, add new events to my calendar.

Pre-requisite: IFTTT secret key should be configured as discribed at Configuring a Plone Site with an IFTTT Secret Key.

Follow the steps given below to Add an IFTTT Content Trigger onto any folder.

1. Traverse to folder on which you desire to apply IFTTT content trigger.
2. From IFTTT menu select Add Ifttt Event Trigger

3. Fill the given form with required values and click Add

4. Tada, trigger has been applied on your folder!!

Behind the Scenes

This section details all jobs performed behind the scenes after form gets filled.

1. A new Content Rule is dynamically created and assigned with requested conditions and IFTTT event name for this folder and it’s sub-folder.

To know more about content rules, follow this link.

2. Rules menu on left bar will show you all content rules applied on this folder.

Content Rule Conditions

1. Default Trigger condition for this content rule is: Workflow state changed

2. Default contition for this content rule is: Workflow State as published

3. Default contition for this content rule is: Content types as Event

Data sent to IFTTT applet

In the data sent to IFTTT, following values will be dynamically included (for which content on the site this content rule triggers):

• Title
• Absolute_url
• Event start date/time

Manage Trigger

This document will guide admins to to see the IFTTT triggers that are set on a folder and delete one or more of them.

Pre-requisite: IFTTT secret key should be configured as discribed at Configuring a Plone Site with an IFTTT Secret Key.

Follow the steps given below to Add an IFTTT Content Trigger onto any folder.

1. Traverse to folder on which you desire to apply IFTTT content trigger.
2. From IFTTT menu select Manage IFTTT Triggers

3. Select the required IFTTT Triggers and click Delete

4. Tada, trigger are deleted on your folder!!

Trigger IFTTT Content Rule Action

Plone Content Rules are a powerful mechanism to automate dealing with content using conditions and actions. It will automatically perform an action when certain events (known as “triggers”) takes place under desired condition.

Collective.ifttt contains a new content rule action, IFTTT Trigger, that posts an event to the IFTTT web service when a content rule’s conditions are satisfied.

Content rules with the IFTTT Trigger is used to implement the IFTTT triggers, which is a powerful mechanism to automate dealing with 3rd party web services that collective.ifttt provides (Content Trigger, Event Trigger, etc.)

You can create your own custom IFTTT trigger event by combining the IFTTT Trigger content rule action with your own conditions

Creating and Defining Content Rules

Following the instructions given on the Plone documentation link. Create a content rule as follows and assign it to a folder on your site (or at the site root):

• Triggering event: Object modified
• Condition: Content type equals News Item
• Action: Select “IFTTT Trigger” from the drop down menu and click on the “Add” button.

• From the “Add IFTTT Trigger” page, fill out the form:
• For the “IFTTT event name” enter: the IFTTT event which you want to trigger.
• Choose the 3rd payload from available options (values of which will be dynamically fetched from the content which trigger this action) :
  • description - Description/Summary of content
  • username - Username of Editor
  • start - Event Start Date/Time
• Click the “Save” button.

Data sent to IFTTT applet

In the data sent to IFTTT, following payload (values) will be dynamically included (for which content on the site this content rule triggers):

• Title
• absolute_url
• Chosen 3rd Payload

Working example of IFTTT Trigger

Now that following the Plone Content Rule we can see IFTTT Trigger in action.

For example, below we will create a new news item and further update it’s content to trigger IFTTT send_email applet.

Create news item

• Select Add new - news item

• Fill in form for new news. And click save.

Update news item

• Select Edit for news item.

• Update news item. And click save.

Triggered the IFTTT Applet