The integration of HotWax Commerce and Klaviyo streamlines the automated notification process for Shopify retailers. Klaviyo, a marketing automation platform among Shopify retailers, integrates with HotWax Commerce. This collaboration empowers retailers to manage e-commerce operations and utilize Klaviyo for automated, personalized notifications.
HotWax Commerce takes the lead in order processing and fulfillment, ensuring effective customer communication through Klaviyo emails. Retailers can configure various flows within HotWax Commerce to notify customers about order updates, such as changes in delivery dates or methods. Notably, the platform provides out-of-the-box Ready to Pickup email triggers, enabling retailers to inform customers when their orders are ready for pickup. These email flows are customizable to meet specific retailer preferences. This user guide focuses on setting up Ready to Pickup emails through Klaviyo, showcasing the flexibility to tailor email flows according to individual client requirements.
Follow the steps provided in this guide to integrate with Klaviyo, enabling automated email notifications and improving the pickup experience for your customers:
Generate API Key from Klaviyo
The API key is a secure passkey that validates and authorizes interactions between HotWax Commerce and Klaviyo. Follow these steps to generate API Key from Klaviyo:
Login to your Klaviyo account with your Klaviyo User Credentials.
Navigate to API Keys:
From the bottom left corner, click on Account
Go to Settings > Account > API Keys.
Create a Private Key:
Click on Private Keys and select Create Private Keys.
Customize API Key:
Provide a name for the API key to distinguish it.
Ensure full access to required API scopes by checking all applicable boxes for the following scopes:
Type of Scope
Description
Accounts
Access to account-level information and settings.
Campaigns
Manage and create marketing campaigns.
Catalogs
Access and manage product catalogs.
Coupon Codes
Manage coupon codes and their configurations.
Coupons
Create and handle coupon details.
Data Privacy
Permissions related to data privacy and compliance.
Events
Track and manage events related to customer interactions.
Flows
Manage automated flows and their configurations.
Images
Access and handle images within the platform.
List
Manage and organize contact lists.
Metrics
Retrieve and analyze performance metrics and data.
Profiles
Access and manage customer profiles and their details.
Push Tokens
Handle push notification tokens for mobile marketing.
Segments
Create, manage, and utilize segments of contacts.
Subscriptions
Manage subscription preferences and details.
Tags
Handle and categorize contacts with tags.
Templates
Access and manage email and campaign templates.
Webhooks
Set up and manage webhooks for real-time data exchange.
Generate the API Key:
Click on the Create button to generate your customized API key.
Copy and Store the Key:
Once created, securely copy and store the API key in a safe location. Avoid sharing it publicly.
Adding API Key in HotWax Commerce
After generating API keys in Klaviyo, it's crucial to integrate them into HotWax Commerce. This step ensures a secure and efficient connection between the platforms, facilitating streamlined communication and data exchange.
Set up API Key in HotWax Commerce:
Access the HotWax Commerce platform and navigate to: https://{instanceName}.io/webtools/control/EntityImport
In the Complete XML document section, add the below given XML information, replacing privateket in publicKey=Klaviyo-API-Key privateKey with the private key generated in Klaviyo:
<SystemProperty systemResourceId="KLAVIYO-STORE" systemPropertyId="revision" systemPropertyValue="2023-12-15" description="API version identified by this revision date (v2023-12-15) used for Klaviyo integration as of the specified release."/>
The XML information contains the following details:
Attribute
Description
SystemMessageRemote Description
Identifies the third-party system for actions.
Send ServiceName
The service name triggering the action.
Send Url
URL of the third-party system (Klaviyo in this case).
Shared Secret
Private API key for HotWax Commerce to interact with Klaviyo.
System Message Remote ID
Identification of the third-party system in HotWax Commerce.
You can verify the newly added entity here- `https://{instanceName}.io/webtools/control/FindGeneric?entityName=SystemMessageRemote``.
Add Product Store Setting in HotWax Commerce
Setting up Product Store email settings in HotWax Commerce is crucial as it automates tailored communication, like the Ready for Pickup email for that product store. Follow these steps to Add Product Store Setting:
Visit https://{instanceName}.io/webtools/control/EntityImport to access the Entity Import interface.
In the Complete XML document section, add the following XML information:
<ProductStoreEmailSetting productStoreId="STORE" emailType="PRDS_READY_TO_PICKUP" subject="Ready For Pickup Email" systemMessageRemoteId="KLAVIYO-STORE" templateContentId="READY_FOR_PICKUP"/>
The XML information contains the following details
Attribute
Description
productStoreId
Enter the name of the product store for which emails will be dispatched.
emailType
Specify the type of email (e.g., "PRDS_READY_TO_PICKUP" for "Ready for Pickup").
subject
Define the subject line for the email ("Ready For Pickup Email").
systemMessageRemoteId
Use the Klaviyo remote ID created in the previous setup step.
templateContentId
Input the ID of the "Ready for Pickup" template content in this instance.
Add Preconfigured Data for the "Ready for Pickup" Email
Within Klaviyo, customized email templates are employed for Ready to Pickup notifications, where the content varies for each order. When a Ready to Pickup email needs to be dispatched, HotWax Commerce generates order-specific data and transfers it to Klaviyo. To enable this process, HotWax Commerce develops and updates individualized data templates for each order, facilitating accurate and personalized email notifications sent through Klaviyo.
This configuration data is sent for
Key
Description
first_name
Customer's first name
last_name
Customer's last name
to_name
Name of the facility for origin
address1
Address line 1
address2
Address line 2
city
City
state_name
State name
country_name
Country name
order_name
Name of the order
order_item
List of shipment items
image_url
URL of the product image
product_name
Description of the ordered product
quantity
Quantity of the ordered item
subtotal
Total amount of items in the shipment
grand_total
Grand total amount for the shipment
To create the Ready for Pickup email template in HotWax Commerce, the provided XML data file needs to be imported via the following link- https://{instanceName}.io/webtools/control/EntityImport
Here's the XML structure that generates the Ready for Pickup email template in HotWax Commerce:
In HotWax Commerce, when orders are packed and ready for pickup, Klaviyo triggers an email to customers containing their specific details. However, it's important to note that Klaviyo does not have a ready-to-pickup email event that can be triggered for action by default. Retailers need to run service named createKlaviyoEvent once before setting up the email flow in Klaviyo to ensure that this event is created in Klaviyo. This step is essential for the effective initiation of the email communication process.
Access the Service List: Go to HotWax Commerce Service List through this link- https://<instanceName>.io/webtools/control/ServiceList
Locate createKlaviyoEvent Service: Find the service named createKlaviyoEvent within the Service List interface. Click on the createKlaviyoEvent service to access its details.
Run the Service: Look for the Run Service button available against the service name and click on it. Finally, click on Submit to execute the service.
To ensure accurate email dispatch for this service, two essential parameters must be provided:
Parameters
Value
productStoreId
Enter the name of the product store for which emails will be dispatched.
emailType
Specify the type of email (e.g., "PRDS_READY_TO_PICKUP" for "Ready for Pickup").
Create a Flow on Klaviyo
Once you have configured the necessary settings and templates in HotWax Commerce, the next step is to create a corresponding flow and template email in Klaviyo to trigger the Ready for Pickup email of the retailer’s choice with the specific details for the customer. This feature focuses on Klaviyo's response when a specific trigger, such as the Ready for Pickup event in HotWax Commerce, occurs. It manages the generation and dispatch of tailored Ready for Pickup emails to customers via Klaviyo, initiated by specific actions, like clicking the Ready to Pick Up button within HotWax Commerce.
Follow these steps to create the email flow in Klaviyo:
Log in to Klaviyo: Access your Klaviyo account using your credentials.
Navigate to Flows: Once logged in, locate and click on the Flows tab within the Klaviyo dashboard. This section is where you manage automated workflows.
Create a New Flow: Click on the create flow button. For the ready-to-pick-up flow, create a new one from scratch.
Choose the Create from Scratch option to begin a new flow.
Name the flow something like Ready for Pickup and click on Create Flow.
Set Trigger Event: Choose the trigger event that will initiate the flow, specifically the Ready for Pickup event associated with actions like clicking the Ready to Pick Up button in HotWax Commerce.
If this trigger isn’t available, ensure that the event has been properly set up or run the necessary service in HotWax Commerce.
Configure Action: Add an action step to the flow that involves sending an email. Look for the action that corresponds to sending emails.
Choose Email Template: Select an existing email template that aligns with the Ready for Pickup scenario. Alternatively, create a new email template specifically tailored for these notifications.
If creating a new template, consider elements like subject line, body content, and any dynamic data placeholders for customer-specific details. Here's an HTML template for the Ready to Pickup Notifications that you can use for your product store.
Replace {image link} with the link of your desired image file
Customize Email Settings: Adjust the email settings, including the sender information, subject line, and the dynamic content that should be populated based on specific customer order details.
Ensure placeholders for dynamic data (such as customer names and order details) are correctly configured to pull the relevant information.
Test the Flow: Before activating the flow, utilize Klaviyo's testing tools to simulate the trigger event and ensure that the email is sent as expected.
Verify that the dynamic data populates correctly in the test emails, ensuring the personalized touch for each recipient.
Activate the Flow: Once satisfied with the configuration and testing, activate the flow to make it live.
Klaviyo will now automatically trigger the `Ready for Pickup`` email based on the defined conditions whenever the corresponding event occurs in HotWax Commerce.