Klaviyo Integration

Awtomic now integrates with Klaviyo so that you can provide a unique subscription email experience to your customers.

In order to set up the Klaviyo integration, go to Awtomic -> Settings -> Integrations and insert your Klaviyo public API key.

To find your Klaviyo public API key, go to the Klaviyo app, press the dropdown beside your account name in the top right corner, and press "Account." In the Account section, press the "Settings" dropdown and press "API Keys." Copy the code under the "Public API Key" label in the first table on the page.

Once you've pasted the public API key into the Awtomic app, you'll be given the option to send a test event and disable Awtomic Emails. We recommend not disabling Awtomic emails until you fully implement and test your new Klaviyo email flows.

To begin setting up the Klaviyo flows, we've enabled the ability to send test events from this page. You can select 'Choose specific event...' or 'All Awtomic events'.

The first option opens a modal window that allows you to choose one event at a time to send to Klaviyo—a great option for testing specific flows. The other option sends all test events simultaneously—which comes in handy when first getting started.

Below are a list of all events that Awtomic will send and the metadata that comes with them. You can use these events and their data to set up your own email flows to be sent to your subscribers:

Subscription Created

{
    "event": "Subscription Created",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27
    }
}

Subscription Upcoming Order

{
    "event": "Subscription Upcoming Order",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "addons": []
    }
}

Subscription Failed Payment

{
    "event": "Subscription Failed Payment",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27
    }
}

Subscription Canceled

{
    "event": "Subscription Cancelled",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "CANCELLED",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "cancellationReason": "Some cancellation reason",
        "cancellationDate": "2022-05-18T09:28:32.729-03:00",
        "triggeredBy": "ADMIN"
    }
}

Subscription Change Frequency

{
    "event": "Subscription Change Frequency",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "days",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "days",
        "paymentInterval": 2,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "oldFrequencyInterval": 2,
        "oldDeliveryFrequency": "Month",
        "triggeredBy": "ADMIN"
    }
}

Subscription Held For Inventory

{
    "event": "Subscription Held For Inventory",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27
    }
}

Subscription Paused

{
    "event": "Subscription Paused",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "PAUSED",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "triggeredBy": "ADMIN"
    }
}

Subscription Reactivate

{
    "event": "Subscription Reactivate",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-05-28T09:28:32.731-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "triggeredBy": "ADMIN"
    }
}

Subscription Set Order Date

{
    "event": "Subscription Set Order Date",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:28:32.734-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "oldNextOrderDate": "2022-05-20T09:28:32.733-03:00",
        "triggeredBy": "ADMIN"
    }
}

Subscription Skipped

{
    "event": "Subscription Skip",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:28:32.734-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "secureLink": "https://manage-subscriptions/url",
        "$value": 27,
        "dateSkipped": "2022-05-18T09:28:32.734-03:00",
        "triggeredBy": "ADMIN"
    }
}

Subscription Send Now (Order Now)

{
    "event": "Subscription Send Now",
    "email": "[email protected]",
    "properties": {
        "id": "1234",
        "deliveryFrequency": "Month",
        "frequencyInterval": 2,
        "nextOrderDate": "2022-07-18T09:24:25.154-03:00",
        "paymentMethod": "Visa ending in 7149",
        "isPrepaid": false,
        "paymentFrequency": "Day",
        "paymentInterval": 1,
        "shippingAddress": {
            "name": "Example Name",
            "address1": "123 Shipping Street",
            "address2": "",
            "city": "Fredericksburg",
            "country": "United States",
            "province": "Virginia",
            "provinceCode": "VA",
            "zip": "22401",
            "phone": null
        },
        "shopifyId": "gid://shopify/SubscriptionContract/1234",
        "status": "ACTIVE",
        "totalDiscounts": 1,
        "totalEstimatedNet": 19,
        "totalLineItemsPrice": 20,
        "totalLineItemsPriceAfterDiscount": 19,
        "totalShipping": 8,
        "variants": [
            {
                "shopifyId": "gid://shopify/ProductVariant/1234",
                "name": "Special Soap",
                "title": null,
                "quantity": 1,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12343",
                    "name": "Special Soap",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/soap.jpg"
                }
            },
            {
                "shopifyId": "gid://shopify/ProductVariant/1235",
                "name": "Bath Bombs - Default Variant",
                "title": "Default Variant",
                "quantity": 2,
                "price": 10,
                "currency": "USD",
                "product": {
                    "shopifyId": "gid://shopify/Product/12344",
                    "name": "Bath Bombs",
                    "image": "https://bundle-public-assets.s3.amazonaws.com/emails/products/bath-bombs.jpg"
                }
            }
        ],
        "triggeredBy": "CUSTOMER",
        "$value": 27
    }
}