Akeneo Integrations and Beyond: Symbiosis of Akeneo and IFTTT

Trilix GmbH
Nov 28, 2019 · 9 min read

Since the release of the Akeneo PIM Events API Bundle building integrations that respond to activities in the Akeneo PIM system has become a lot easier (read the full article for more details). Instead of sending notifications about events to a custom endpoint they can be also sent to services you already use, such as your email or task organization system. This can be done by interconnecting the Akeneo PIM Events API Bundle with the web-based service IFTTT (If This Then That) which is a great and sophisticated instrument that integrates plenty of internet services (All services provided by IFTTT can be found here: https://ifttt.com/services)

In the following we will provide you with a step by step manual that guides you through the implementation of IFTTT for Akeneo. To demonstrate its usage together with Akeneo two example implementations are given, which are 1) receiving email notifications for Akeneo events and 2) automatically create notifications based on Akeneo events within the Trello task management service.

Before you get started, make sure that you have installed the Akeneo PIM Events API Bundle and created a user account for IFTTT.

Use case 1: Receiving email notifications for Akeneo events

For every event that occurs in your Akeneo PIM system you can be notified via email.

Technically this happens because IFTTT service as a consumer within the Akeneo PIM Events API Bundle which receives a JSON payload from Akeneo and subsequently sends an email to you with information about the event.

The interconnection of IFTTT and other system is achieved via so called applets. These are small applications that work with one or few functions, e.g. a sequence of conditional statements like “if this then that” (more information about IFTTT applets can be found here).

In order to set up the email notification for Akeneo events you just need to apply the following steps 1 to 7 to create the necessary IFTTT applet (log in and start here: https://platform.ifttt.com/) and configure the Akeneo PIM Events API Bundle accordingly (steps 8–9).

Set up of IFTTT applet

STEP 1: Select “Applets” in item menu and click on “New Applet”

If you have just created an account, you won’t be able to see “Applets” within the item menu yet. You have to click the “Try Now” button first and enter the requested data before the “Applets” section will appear in the menu. For this use case, please select “Private” in the “Applets” menu since you do want to use this applet for your privately only. Now you can click on the “New Applet” button.

STEP 2: Set up a trigger

You have now initiated the applet configuration. This starts with setting up a trigger. Select the “Webhooks” service and choose “Receive a web request” as trigger from the drop down menu.

In general, the Webhooks service allows you to integrate other services on IFTTT with your DIY projects via simple web requests.


STEP 3: Add and specify an action that should be fired

After you have configured the trigger you need to add an action which should be fired according to the trigger. To do this, click the “Add action” button and select “Email” as a service in the search field. After that you can select the “Send me an email” action.

Finally, you will have to define the field value in the “Value” field at the bottom. This is very important because here the actual content of the email you will receive is defined. That means in the “Value” field of “Body” it will be specified what data should be extracted from an event and put it into the email body.

IFTTT Webhooks service can only receive data with keys of:

  • value1
  • value2
  • value3

Those keys (value1, value2, value3) are called “ingredients” in the Webhooks service.

In IFTTT each trigger contains ingredients which are individual pieces of data. You can take the individual ingredients provided by a trigger and use them to fill in an action’s action field. For the Webhooks service there are currently the following “ingredients” available:

  • value1
  • value2
  • value3
  • EventName
  • OccuredAt

STEP 4: Define the applet title and description

Finally, you need to enter a title and a description for the applet, for example “Akeneo Events — Email Notification” or a more specific title according to the event you like to be notified about.

You have finished the creation of the applet now and are ready to click on the “Save” button.

STEP 5: Turn on and connect your applet

After you have created the applet, a new screen appears on which you have to click on the “Turn on” button under “Display preview”.

On the next appearing screen you will see the “Connect” button. Just click on it. Your applet is now activated and ready to be connected.

STEP 6: Connect your email account

On the next screen you will have been redirected to the page that asks for the email address which should receive the Akeneo PIM events notifications. A 4-digit PIN will be sent to your email and you need to enter it. You have just connected the newly created email service applet to your email account.

STEP 7: Verify connection and create an event name

After having submitted the PIN you will have to enter an event name.

You should see the screen with your applet name now confirming the connection.

That’s it. Now you are ready to use the Applet.

Configuration of Akeneo Events API Bundle

STEP 8: Configure the Akeneo Events API

The connection between your email account and the Akeneo PIM system will be established once you have configured the Akeneo PIM Events API Bundle following these three steps:

  1. Go to the Webhooks service which was configured before and get the events_api_request_url in app/config/parameters.yml file. Then select it on https://ifttt.com/ and click the “Documentation” button.

You will see this screen now:

2. Change {event} placeholder to your {event name}, defined in STEP 7. For the given example this would be:

events_api_request_url: ‘https://maker.ifttt.com/trigger/akeneo_event_happened/with/key/dYhfahsr9F2PDYAEYwIO0r'

3. Change the transport factory to IFTTT factory (pim_events_api.transport_factory.ifttt_webhooks) within the Akeneo PIM Events API configuration: app/config/config.yml

At this stage everything is configured so that the events will be delivered to the IFTTT Webhooks service.

STEP 9: Adjust category in Akeneo

Now you can go to the Akeneo PIM system settings and change the product category.

That’s it. With the email you will receive with the first notification about the updated Akeneo event (category_updated) and you have finished the set up.


Use case 2: Integrating Akeneo event notifications into Trello

For setting up the interconnection between Akeneo and Trello you have to follow similar steps and again need to start with creating an applet in your IFTTT account.

Set up of IFTTT applet

STEP 1: Select “Applets” in item menu and click on “New Applet”

Go into the “Applet” section again where you will see your created email notification applet now and click again on “New Applet”.

STEP 2: Set up a trigger

For this applet you will also have to choose “Webhooks” as the service and select “Receive a web request” as trigger to receive events from Akeneo and end directly interconnect IFTTT with Trello.

STEP 3: Add and specify action that should be fired

For this use case, please, search for Trello in the search field and select “Create a card” as the action that should be performed.

STEP 4: Specify the “Value” field

In this step you need to fill in the “Value” field again. This will provide the card content for the Trello system later.

STEP 5: Define the Applet title and description

Finally, you need to enter a title and a description for the applet, for example “Akeneo Events — Trello Integration” or a more specific title according to the event you like to be notified about.

You have finished the creation of the applet now and are ready to click on the “Save” button.

STEP 6: Turn on and connect your applet

After you have created the applet a new screen appears on which you have to click the “Turn on” button under “Display preview”.

On the next appearing screen you will see the “Connect” button. Just click on it. Your applet is now activated and ready to be connected.

STEP 7: Connect your Trello account

On the next screen you will have been redirected to a page that asks you to provide IFTTT with an access to your Trello account. Click on the “Allow” button here.

STEP 8: Create event name and select Trello board

Following this you need to define an event name. You can also choose the Trello board that should receive the notifications about the Akeneo event changes.

Configuration of Akeneo Events API Bundle

In order to complete the setup of the Trello notifications you also have to connect this applet with the Akeneo PIM system and configure the Akeneo Events API Bundle. For this, please repeat STEP 8 and 9 from the email notification use case above.

Now everything is ready to use. You can go into Akeneo and change any entity.

After that you will see the new card on the Trello board:

Thank you for reading and keep in touch!

Our Akeneo PIM Events API Bundle is open source and freely available on GitHub

Contact: mail@trilix.co

Website: https://www.trilix.co/work/events_api

Akeneo Marketplace: https://marketplace.akeneo.com/extension/akeneo-pim-events-api

Trilix GmbH

Written by

Trilix GmbH is a Germany based software development company with expertise in Akeneo PIM, Magento, System Integrations

Welcome to a place where words matter. On Medium, smart voices and original ideas take center stage - with no ads in sight. Watch
Follow all the topics you care about, and we’ll deliver the best stories for you to your homepage and inbox. Explore
Get unlimited access to the best stories on Medium — and support writers while you’re at it. Just $5/month. Upgrade