Summary

This document explains the Klaviyo export, how it works, and provides detailed instructions on how to enable the export for a brand.

Purpose

The purpose of the Klaviyo export is to provide brands with TYB-specific data on their customers, delivered to their CRM (Klaviyo, in this case). Data is sent as Klaviyo profile objects, keyed on user email. This enables brands to tailor outreach to TYB customers specifically, with the ability to filter by attributes like membership tier or coin balance.

Profile Data

The export process will populate TYB member profiles with the following data

• email (this is the identifier for the member)
• tyb_community_member (True/False - see below)
• tyb_membership_tier (e.g. Bronze)
• tyb_coin_balance (integer)
• tyb_user_uuid (the brand member’s internal TYB identifier, used for debugging if necessary)
• tyb_collectibles_owned (a list of brand collectibles owned by this brand member)

In the case that the user leaves the brand community or leaves TYB entirely, the tyb_community_member field will flip to False and all other fields will be set to null.

Note that the full set of data is sent daily, so any manual changes to these fields will be overwritten when the job runs next.

Brand Setup

In order to enable the export, a brand will need to complete the following steps:

1. Generate a Klaviyo API key

   1. From your Klaviyo dashboard, go to Settings in the lower left-hand menu

      

   2. Go to Account > API keys and click on Create Private API Key

      

   3. Select Custom Key and enable Read/Write Access on List and Profiles. This is important; if you do not enable these permissions, your export will not work! Give your key a name and click Create.

      

   4. You will only be able to access your key once, so make sure you download it to a safe location. You can also copy it so it will be available in your clipboard for the next step

   

2. Register the API key with TYB on the admin dashboard

   1. Go to your brand’s admin dashboard (add /admin to the base URL)

   2. Select Settings at the bottom of the lefthand navigation bar, and then go to Integrations

      

   3. Scroll down to the Klaviyo section and click on + Connect API key

      

   4. Paste the key from step 1 into the box and click Save changes