This article walks subscribers or their MiSP through installing the Klaviyo subscription on iPaaS.com: obtaining Klaviyo credentials, subscribing to the integration, configuring the subscription settings, and verifying the installation with a Manual Sync.
Before You Begin
Before installing the Klaviyo subscription, obtain authentication information from Klaviyo. The Klaviyo API supports two authentication methods:
OAuth 2.0 (recommended)
Private API Key
OAuth 2.0 is recommended because it avoids storing a long-lived key in the subscription settings. Choose one method; you do not need both.
Creating a Private API Key (optional)
If you choose to authenticate with a private API key, create one in Klaviyo first:
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 access for every API scope.
Click Create, then record the generated private API key. You will enter this value as the API Key when configuring your subscription.
NOTE: The private API key method is not recommended, because the key is visible to all users within your subscription's company in iPaaS.com. For enhanced security, use the OAuth 2.0 method described in Authenticating with OAuth 2.0 below. |
You can now start installing the Klaviyo subscription.
Subscribing to the Klaviyo Integration
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Klaviyo integration title.
On the Subscription Detail page, click Subscribe.
Enter the Name of the subscription and select a Version. The name can be any relevant, unique value within the company where the subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Klaviyo - Release
Select Create Default Mappings (recommended).
NOTE: If you prefer to build all mappings from scratch, clear the Create Default Mappings checkbox. |
Configuring the Subscription Settings
On the subscription's settings, complete the four Klaviyo settings below, then click Apply to save.
Setting | Required | Description |
API Url | Required | The Klaviyo API endpoint. The URL is the same for every Klaviyo account; it is not instance-based. Enter https://a.klaviyo.com for both test and production environments. |
API Key | Optional | The private API key generated in Klaviyo. Leave this blank if you intend to authenticate with OAuth 2.0. |
API Revision | Optional | The Klaviyo API version to lock requests to, which keeps the integration stable when Klaviyo releases newer API versions. When this value is left blank, the integration uses the default revision 2023-10-15. |
Generate Events (TRUE/FALSE) | Optional | Controls whether the integration generates Klaviyo branded events for a profile. When set to TRUE, an event is created whenever a qualifying action is performed. When left blank or set to FALSE, no branded events are generated. |
After saving the settings, complete authentication. If you entered a private API key above, authentication is complete. If you chose OAuth 2.0, follow Authenticating with OAuth 2.0 below.
Authenticating with OAuth 2.0
OAuth 2.0 is the recommended method. After the subscription is created and the settings are saved, authorize the integration from within the subscription:
Open the Klaviyo subscription you created.
Click the Authentication icon in the top toolbar.
A new browser window opens requesting permissions for the application. Click Continue.
Click Allow when prompted. After the confirmation page is displayed, you may close it.
Refresh the subscription. The access token values are now present if authorization succeeded.
NOTE: The Klaviyo access token expires after a period and is removed from the subscription's stored data. The refresh token regenerates the access token automatically, so no manual re-authorization is needed while the refresh token remains valid. |
Removing OAuth 2.0 Authorization in Klaviyo
To revoke the integration's access from the Klaviyo side:
Log in to Klaviyo using your credentials.
Click Integrations in the sidebar menu.
Open 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 installation and authentication are complete, run a Manual Sync to confirm the connection works end to end:
Open the Klaviyo subscription and run a Manual Sync for the Customer/Profile flow.
Confirm an inbound sync brings recently updated Klaviyo profiles into iPaaS.com. A profile whose email matches an existing iPaaS.com Customer links automatically; an unmatched profile creates a new Customer.
Confirm an outbound sync creates or updates a profile in Klaviyo from an iPaaS.com Customer.
Review the results in the Dashboard under Integration Monitoring and check the Error Logs for any failures, then validate that field mappings populated as expected.
If both directions complete without errors, the installation is verified.
Support and Troubleshooting
If a sync reports an error, review it in the Dashboard under Integration Monitoring, then open the Error Logs for the affected subscription to see the message and the record involved.
For additional help, click the Help button on any iPaaS.com page to contact Support or search the documentation.
Documentation: Search the documentation at the top of this article.
Support Portal: Click the Help and Support button at the lower right of any iPaaS.com page, or visit https://support.ipaas.com/en/.
Contact Information: Contact iPaaS.com.