My Cart

Events for marketing platforms

Events for Marketing Platforms

This section describes events that can be used for sending emails. Currently, only Klaviyo is supported.

 If you have specific integration needs, please don't hesitate to contact us.

 

Klaviyo Setup

Follow these steps to configure events:

  1. Purchase Klaviyo Extension:
  2. Access Keys:
    • Go to My Profile > My Purchases, open “Access Keys,” and copy your credentials.
  3. Configure Store Credentials:
    • Navigate to your store’s root directory (/var/www/html/).
    • Open the auth.json file and enter the copied credentials in the “username” and “password” fields.
  4. Install Klaviyo Extension:

Run the following command in the console:

composer require klaviyo/magento2-extension

Follow up by running all necessary setup commands to complete the installation.

    5.Install Required Add-ons:

    • Install the following add-ons on your store:
      • module-sarp3-events
      • module-sarp3-events-klaviyo
  1. Create Klaviyo Account:
    • Sign up for a test account at Klaviyo.
  2. Retrieve API Keys:
    • In your Klaviyo account, go to Settings > Account > API Keys:
      • Copy the Public API Key.
      • Generate and copy the Private API Key (note that you can view this only once).
  3. Configure Klaviyo in Store:
    • In your store’s admin panel, navigate to Stores > Configuration > KLAVIYO > General.
    • Enable Klaviyo and enter the copied API keys, then save the changes.
  1. Setup OAuth Integration:
    • Go to Stores > Configuration > KLAVIYO > Setup OAuth.
    • Enter a name in the Integration Name field and save the settings.
  2. Activate Integration:
    • In your store’s admin panel, navigate to System > Extensions > Integrations.
    • Click Activate.

Events

Event name

Event code

Property

Subproperty

Property type

Reference

 

Subscription Created

subscription_created

         
   

subscription_details

 

object

"SubscriptionDetails" object

 

Upcoming Billing

subscription_upcoming_billing

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

next_billing_date

 

string

dd/mm/Y

 

Billing Successful

subscription_billing_successful

         
   

subscription_details

 

object

"SubscriptionDetails" object

 

Billing Failed

subscription_billing_failed

         
   

subscription_details

 

object

"SubscriptionDetails" object

 

Subscription Cancelled

subscription_cancelled

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

link_to_reactivate

 

string

   

Subscription Reactivated

subscription_reactivated

         
   

subscription_details

 

object

"SubscriptionDetails" object

 

Subscription Paused

subscription_paused

         
   

subscription_details

 

object

"SubscriptionDetails" object

 

Subscription Rescheduled

subscription_rescheduled

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

old_payment_date

 

string

yyyy-MM-dd HH:mm:ss

 
   

new_payment_date

 

string

yyyy-MM-dd HH:mm:ss

 

Subscription Ended

subscription_ended

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

link_to_reactivate

 

string

   

Orders Merged

subscription_orders_merged

         
   

subscriptions

 

array

Array of "SubscriptionDetails" objects

 
   

subscription_product_names

 

array

   

Changed Plan

subscription_changed_plan

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

changes

 

object

   
     

from

object

"Plan" object

 
     

to

object

"Plan" object

 

Changed Address

subscription_changed_address

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
     

changes

 

object

 
       

from

object

"Address" object

       

to

object

"Address" object

Changed Payment Method

subscription_changed_payment_method

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

changes

 

object

   
     

from

string

   
     

to

string

   

Changed Products

subscription_changed_products

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

changes

 

object

   
     

from

object

"Product" object

 
     

to

object

"Product" object

 
     

is_permanently

bool

   

Item Removed

subscription_item_removed

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

item

 

object

"Product" object

 

Item Added to Nearest Delivery

subscription_item_added_to_nearest_delivery

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

items

 

array

Array of "Product" objects

 

Item Added to Subscription Profile

subscription_item_added_to_subscription_profile

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

items

 

array

Array of "Product" objects

 

Item Skipped

subscription_item_skipped

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

item

 

object

"Product" object

 

Item Skipped: Undo

subscription_item_skipped_undo

         
   

subscription_details

 

object

"SubscriptionDetails" object

 
   

item

 

object

"Product" object

 

 

Event object

Property

Subproperty

Property type

Reference

SubscriptionDetails

   

object

 
 

plan

 

object

"Plan" object

 

products

 

array

Array of "Product" objects

 

secure_link

 

string

Secure link to subscription profile

 

addreses

 

object

 
   

shipping

object

"Address" object

   

billing

object

"Address" object

Plan

   

object

 
 

name

 

string

 
 

is_initial_fee_enabled

 

bool

 
 

is_trial_period_enabled

 

bool

 
 

regular_repeat

 

string

 
 

trial_repeat

 

string|null

 
 

regular_repeat_in_days

 

int

 
 

trial_repeat_in_days

 

int|null

 
 

subscription_start_date

 

string

yyyy-MM-dd HH:mm:ss

 

initial_fee

 

float|null

 
 

number_of_regular_payments

 

int

 
 

number_of_trial_payments

 

int|null

 
 

number_of_trial_payments

 

int|null

 
 

regular_payment_amount

 

float

 
 

trial_payment_amount

 

float|null

 
 

is_service

 

bool

 
 

currency

 

string

 

Product

   

object

 
 

ProductId

 

int|string

 
 

ProductName

 

string

 
 

SKU

 

string

 
 

Quantity

 

float

 
 

ProductOptions

 

array

Array of "ProductOption" objects

ProductOption

       
 

label

 

string

 
 

value

 

string|int

 

Address

   

object

 
 

first_name

 

string

 
 

last_name

 

string

 
 

middle_name

 

string|null

 
 

country

 

string

 
 

city

 

string

 
 

region

 

string

 
 

street

 

string

 
 

postcode

 

string

 
 

telephone

 

string

 

UserProperties

   

object

 
 

email

 

string

 
 

active_subscriber

 

bool

Has customer at least one active subscription

 

active_subscriptions

 

array

Array of active subscriptions product names

 

inactive_subscriptions

 

array

Array of inactive subscriptions product names

 

active_plans

 

array

Array of active subscriptions plan names

 

inactive_plans

 

array

Array of inactive subscriptions plan names

 



 

 

Write Your Own Review

Already used our product?

We would appreciate your feedback. Please, leave a review.

Only registered users can write reviews. Please Sign in or create an account
Report incorrect information

Still Have Questions?

Our customer care team is here for you!

Contact Us