Skip to main content

Integration setup

API key setup​

VTAGZ connects to Klaviyo using their Private API Key system. Follow these steps to establish the connection:

Creating the API key in Klaviyo:

  1. In your Klaviyo account, create a new Private API Key
  2. Name the key "VTAGZ" for easy identification
  3. Assign read & write permissions for:
    • Subscriptions
    • Lists
    • Profiles
    • Events
  4. Copy the generated API key

Adding the key to VTAGZ:

  1. Navigate to your VTAGZ campaign dashboard
  2. Go to the SMS settings for your campaign
  3. Paste the API key into the designated field

Custom profile property setup​

VTAGZ uses custom profile properties to assign each subscriber a unique URL for receipt uploads. This property should be automatically created when you add your API key, but you can set it up manually if needed:

Manual setup:

  1. Open Profiles in your Klaviyo dashboard
  2. Select any profile from the list
  3. Next to Custom properties, click Add custom property
  4. Configure the property:
    • Property name: upload_link
    • Property value: test

You can now use this custom property (upload_link) in your SMS flows to include personalized redemption links.