Before You Begin
Before you begin installing the Klaviyo subscription, obtain authentication information from Klaviyo.
Klaviyo APIs supports two types of authentication:
Authentication by API KEY
Authentication by OAuth 2.0 (Recommended)
To use Authentication by API Key:
Log in to Klaviyo using your credentials.
Select your account at the bottom of the sidebar menu and select Settings.
On the Settings page, select Account > API Keys.
Click Create Private API Key.
Provide a Private API Key Name, then select Full Access Key to grant full access for every API scope.
Click Create. Record the generated Private API Key.
You will use this key when setting up your subscription.
NOTE: This authentication method is NOT recommended, as the API key will be visible to all users within your subscription’s company in iPaaS.com. For enhanced security, it is recommended to use the OAuth 2.0 method by following the steps outlined in the “Operational Configuration – OAuth 2.0 Flow Initialization” section below. |
You can now start installing the Klaviyo subscription.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Klaviyo Integration title.
On the Subscription Detail page, click the Subscribe button.
Enter the Name of the subscription and select a Version . It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Klaviyo – Release
Select Create Default Mappings (recommended).
NOTE: If you don’t want to create default mappings and want to create all mappings from scratch by yourself, then uncheck this box.
Provide the API URL endpoint for your Klaviyo instance. The Klaviyo API URL is same for all instances. It is not instance-based.
Environment URLs:
Test/Sandbox: https://a.klaviyo.com
Production: https://a.klaviyo.com
Enter the API Key you generated in Klaviyo.
Enter the API Revision. An API revision ensures stable and consistent integration by locking requests to a specific API version. When you enter an API revision, you're specifying the exact version of the API you want to use. This prevents unexpected changes from newer versions from breaking your application. For Subscription Settings, the API revision is optional. If you don't provide one, the system will automatically use the default API revision, which is 2023-10-15.
Set Generate Events (True/False). This setting controls whether branded events are generated for a profile by enabling or disabling this setting. When this preset is explicitly set to true in the subscription settings, the system will automatically generate an event for the profile whenever an action is performed. If you don't enable this setting, no events will be generated. This gives you the flexibility to turn branded event generation on or off based on your specific business needs.
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Klaviyo can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. . If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
If you decided not to use the API Key for authentication and opted for OAuth 2.0 Flow Initialization, there are additional steps to perform.
Initiating OAuth 20. Flow
To initiate the OAuth 2.0 Flow and generate an access token:
Go to your Klaviyo Subscription that was created.
Click the Authentication icon found in the top toolbar:
A new browser window opens requesting permissions for the application.
Click Continue
Click Allow when prompted. After a confirmation page is displayed, you may close the next page:
Refresh the subscription and the access token values should now be present if successful.
NOTE: The Klaviyo Access Token expires after some time and are deleted from subscription persistent data. The Refresh Token is supposed to regenerate the access token. |
See the next section to remove the authentication externally.
Removing OAuth 2.0 Externally
Log in to Klaviyo using your credentials.
Click Integrations in the sidebar menu.
Click the menu for the integration you want to remove, and select Remove integration.
Click Remove integration in the dialog box. Klaviyo removes the authorization.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test
Initiate a sample data pull. (To iPaaS.com).
Initiate a sample data push. (From iPaaS.com).
Functionality Test
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.