Iterable integrates with Magento, enabling customers to automate their multi-channel marketing strategy by ingesting user and event data captured by their Magento-powered e-commerce website. Simply drop your Iterable API key into the Iterable Magento app to begin automating campaigns that encourage purchases and boost customer retention.
If you’re not already an Iterable client, request a demo to discuss the how the Iterable and Magento integration can work for you.
Iterable Magento Connector - Installation Guide
The module can be installed in two ways:
- Manually via FTP
- Using the Composer package manager
Installing via FTP
This installation option requires you to have a compressed (for example, zip or tar) version of the module.
First, create the following directories in your Magento2 web-root:
Using an FTP client, copy the contents of your zip/tar file into the above directory.
Run the following commands to install the module:
php bin/magento setup:upgrade
php bin/magento cache:clean
In Magento, navigate to Stores > Configurations. You should see a new Iterable tab.
Installing via Composer
To be able to install module using Composer, you must have it installed on your server, and the module must have been purchased via Magento Marketplace.
Navigate to the web-root of your website and run following command:
composer require iterable/connector
If you have not done that before, it will require you to plug in your Magento marketplaces public and private keys. These can be obtained from the Magento account that you created when purchasing the module. Once Composer brings all the necessary files into Magento, run the following commands to trigger installation:
php bin/magento setup:upgrade
php bin/magento cache:clean
Setting up your integration
The following sections describe how to:
- Generate your Iterable API key
- Paste it into your Magenta Iterable integration
- Test your connection
Generate your Iterable API key
This step assumes that you already have an account with Iterable.
To generate an Iterable API Key:
Navigate to Integrations > API Keys:
Click Create New API Key.
In the drop-down menu, choose Magento:
Click Create. This will generate a new API key, which will be visible on the list of all API keys.
Paste the API key into your Magento Iterable integration
As shown on the below screenshot, paste your API key into the Iterable configuration area in Magento and save your settings.
Test your connection
Once the API key is saved, click Test Connection to verify that the connection is valid. If it is, then you should see a popup screen as shown below. If not, then double-check the API key against your Iterable account.
Next, select the functionality you would like to enable. The following sections describe the available options.
- Logging for debugging purposes
- Pushing all existing customers to Iterable
- Customers cart updates
- Customers order information
- Customers registrations
- Customers page view tracker
- Customers login tracker
- Transactional emails
- Sending coupon codes
Logging for debugging purposes
Having this feature on allows you to see requests and responses going to and from Iterable and Magento. If for some reason you don’t see data coming through, this is a good place to check. You can look at the logs by opening this file in the webroot of your website:
Pushing all existing customers to Iterable
Since the extension may have been installed at a point when the store has already generated many customers, this feature allows pushing all existing customers into Iterable with the click of a button. For this to work, you need to have your crons running and configured from the server side. This, in most cases, should already be working as Magento2 requires it by default. Click on the schedule button and confirm action. With the next cron run, all existing customers will be pushed to your Iterable account.
Customers cart updates
Having this enabled will push all data related to a customer's cart. Please note that this will apply only to registered and logged-in users, as Iterable requires users to have associated email addresses as their primary identifiers. This event is triggered every time a user updates their cart by adding or updating products in it.
Customers order information
This event pushes all order related data to Iterable after the order has been placed. In the event history, it gets associated with the user who placed the order.
This event is triggered when a user registers on the website. User data is being sent to Iterable where a new record is created.
Customers page view tracker
This feature allows Iterable to track page views of all logged-in users. This event will be reflected in the user’s event history.
Customers login tracker
Every time a user logs in, this event will notify Iterable and will be available in the event history.
Transactional emails have their own section. It lists all available transactional emails in Magento to be intercepted by the module. Every type of transactional email can be turned on and off. In disabled mode, core Magento functionality will work as normal. Configured in Magento email templates will be used. In enabled mode, the module will intercept data that was intended for this specific email template and push it to Iterable. In this case, email will not be sent by Magento and Magento templates will not be used. Raw data can be used to configure new templates in Iterable.
Sending coupon codes
Coupon code functionality allows you to attach coupon codes to certain email templates and send them to Iterable. Discount or other types of coupon codes can be generated in Magento or elsewhere and be pasted as shown on the screenshot below:
Essentially this field accepts text, which is then added to the email
data and becomes available in the Iterable template with the key
This can be output anywhere in the email, just like any other piece of data.
This feature of the module brings in an API endpoint that returns the status of the product. It allows you to utilize advanced feature webhooks in your Iterable account. For detailed instructions on how to use webhooks, read Using webhooks.
This API endpoint makes this URL available:
It works with GET requests and returns status code 200 if the product is available or 400 if it is not.