Klaviyo

tap-klaviyo (hotgluexyz variant)🥈

Email Marketing and SMS Marketing Platform

The tap-klaviyo extractor pulls data from Klaviyo that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-klaviyo extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-klaviyo --variant hotgluexyz
  3. Configure the tap-klaviyo settings using
    meltano config
    :
  4. meltano config tap-klaviyo set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-klaviyo test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-klaviyo may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-klaviyo settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-klaviyo list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Key (api_key)

  • Environment variable: TAP_KLAVIYO_API_KEY

Klaviyo API Key


Configure this setting directly using the following Meltano command:

meltano config tap-klaviyo set api_key [value]

Start Date (start_date)

  • Environment variable: TAP_KLAVIYO_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-klaviyo set start_date [value]

User Agent (user_agent)

  • Environment variable: TAP_KLAVIYO_USER_AGENT

Klaviyo user agent


Configure this setting directly using the following Meltano command:

meltano config tap-klaviyo set user_agent [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-klaviyo extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-klaviyo --variant hotgluexyz

Maintenance Status

  • Maintenance Status

Repo

https://github.com/hotgluexyz/tap-klaviyo
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Hotglue

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api