tap-klaviyo - Meltano Hub

Klaviyo

tap-klaviyo (airbyte 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.

Airbyte Usage Notice

This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.

Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.

For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs.

Alternate Implementations

Getting Started

Prerequisites

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

Installation and configuration

Add the tap-klaviyo extractor to your project using
```
meltano add
```
:

meltano add extractor tap-klaviyo --variant airbyte

Configure the tap-klaviyo settings using

meltano config

meltano config tap-klaviyo set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-klaviyo test

Next steps

Follow the remaining steps of the Getting Started guide:

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:

about
catalog
discover
schema-flattening
state
stream-maps

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:

airbyte_config.api_key
airbyte_config.start_date
airbyte_spec.image
airbyte_spec.tag
docker_mounts

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

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.

Airbyte Config Api Key (airbyte_config.api_key)

Environment variable: TAP_KLAVIYO_AIRBYTE_CONFIG_API_KEY

Klaviyo API Key. See our docs if you need help finding this key.