Magento integration system requirements reference

You will learn

Learn about the system requirements for optimal syncing with Magento 1 or 2. The administrator of your Magento store is responsible for system specifications and configuration. Ensuring that your system is configured to work with Klaviyo will enable a smooth integration experience.

Magento 2 versions below 2.4.0 are not supported.

Configure API permissions

For an existing Magento 1 integration, the SOAP API user needs full resource access. Make sure Resource Access is set to All.

For Magento 2, install and configure the Klaviyo extension, then set up OAuth and approve the requested API permissions. Follow the Magento 2 integration guide to complete setup in Magento and enable the integration in Klaviyo.

Without the necessary API permissions, Klaviyo will not be able to properly interact with your Magento store’s APIs, which will prevent the integration from retrieving data from your store.

Enable access to required API endpoints

Klaviyo requests data from specific endpoints. Your system configurations must allow access to these endpoints; consider the impact of security controls or URL redirection logic on the accessibility of these endpoints to Klaviyo. If Klaviyo does not have access to the expected API endpoints, some or all Magento data will be unable to sync and you will see error reporting in the application.

For Magento 2, your store must have a publicly accessible hostname. Allow Klaviyo to reach /oauth/token/request and /oauth/token/access for OAuth authentication, as well as the REST API under /index.php/rest. If authentication fails, follow the Magento 2 troubleshooting guide.

All outbound Klaviyo integration traffic is behind a set of predictable, static IP addresses so that you can have a high level of confidence that this traffic is coming from Klaviyo; we recommend allowlisting these addresses.

System capacity for historical data sync API requests

When you activate the integration, Klaviyo automatically queues API requests to sync historical data including customer records, order records, and the product catalog. We attempt to do this quickly to empower marketers to use this data in their accounts as soon as possible. We also attempt to do this responsibly by limiting concurrency and by gracefully handling retries. If your store has a high volume of historical data, limited resource capacity, or other applications that make substantial API requests, we recommend consulting your Magento administrator to ensure your infrastructure is equipped to support the historical data sync. Your administrator may want to consider temporarily increasing resources or applying auto-scaling.

Verify SSL certificate validity

An SSL certificate digitally authenticates the identity of a website and enables an encrypted connection between a web browser and a web server. Your website’s SSL certificate is hosted by the site’s origin server. A valid SSL certificate is critical to accepting payment securely, protecting password logins, and securing web forms. SSL Server Test can be used to verify a website’s SSL certificate.

Magento integrations may become disabled if your website’s SSL certificate expires. In this case, the domain and intermediate certificates must be updated on the hosting provider. If you are unsure of the location of your certificates, reach out to your hosting provider for assistance.

Sufficient server memory allocation

Disk space for products, product images, stored emails, and static content pages is separate from PHP memory. Sufficient disk space does not mean PHP has enough memory to process Klaviyo’s API requests.

We recommend over 1 gigabyte of memory allocated to your Klaviyo integration, but 512 megabytes is the required minimum. If your server cannot allocate sufficient resources to respond to Klaviyo’s requests, integration errors will occur. The Klaviyo-Magento integration begins with a sync of historical data, so it is recommended you verify memory settings in Magento and your server before activating the integration.

Check the PHP memory_limit setting used by your Magento web server. PHP’s default is 128 megabytes, but your hosting configuration can override it. Your Magento administrator can update this setting in php.ini. For Magento 2, also follow Adobe’s PHP settings guidance.

Use UTC timestamps for syncing

Klaviyo uses Coordinated Universal Time (UTC) to request recent Magento data and interpret timestamps returned by the APIs. Incorrect timestamps can cause records to be missed during syncing or appear at the wrong time in Klaviyo.

Have your Magento administrator verify that the timestamps returned by your store’s APIs are in UTC. If recent records are missing or show incorrect times, check those timestamps and your server configuration before changing your store’s timezone settings.

Additional resources