airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceKlaviyo

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceKlaviyo;
import com.pulumi.airbyte.SourceKlaviyoArgs;
import com.pulumi.airbyte.inputs.SourceKlaviyoConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceKlaviyo = new SourceKlaviyo("mySourceKlaviyo", SourceKlaviyoArgs.builder()
            .configuration(SourceKlaviyoConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .disable_fetching_predictive_analytics(true)
                .num_workers(1)
                .start_date("2017-01-25T00:00:00Z")
                .build())
            .definitionId("2b3afbaf-d4bc-4d4d-8b70-a755581e44c3")
            .secretId("...my_secret_id...")
            .workspaceId("2b8b9017-7907-4706-8721-11272beb5dbf")
            .build());

    }
}

resources:
  mySourceKlaviyo:
    type: airbyte:SourceKlaviyo
    properties:
      configuration:
        api_key: '...my_api_key...'
        disable_fetching_predictive_analytics: true
        num_workers: 1
        start_date: 2017-01-25T00:00:00Z
      definitionId: 2b3afbaf-d4bc-4d4d-8b70-a755581e44c3
      secretId: '...my_secret_id...'
      workspaceId: 2b8b9017-7907-4706-8721-11272beb5dbf

Create SourceKlaviyo Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceKlaviyo(name: string, args: SourceKlaviyoArgs, opts?: CustomResourceOptions);

@overload
def SourceKlaviyo(resource_name: str,
                  args: SourceKlaviyoArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceKlaviyo(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceKlaviyoConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)

func NewSourceKlaviyo(ctx *Context, name string, args SourceKlaviyoArgs, opts ...ResourceOption) (*SourceKlaviyo, error)

public SourceKlaviyo(string name, SourceKlaviyoArgs args, CustomResourceOptions? opts = null)

public SourceKlaviyo(String name, SourceKlaviyoArgs args)
public SourceKlaviyo(String name, SourceKlaviyoArgs args, CustomResourceOptions options)

type: airbyte:SourceKlaviyo
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceKlaviyoArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceKlaviyoArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceKlaviyoArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceKlaviyoArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceKlaviyoArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceKlaviyoResource = new Airbyte.SourceKlaviyo("sourceKlaviyoResource", new()
{
    Configuration = new Airbyte.Inputs.SourceKlaviyoConfigurationArgs
    {
        ApiKey = "string",
        DisableFetchingPredictiveAnalytics = false,
        NumWorkers = 0,
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceKlaviyo(ctx, "sourceKlaviyoResource", &airbyte.SourceKlaviyoArgs{
Configuration: &.SourceKlaviyoConfigurationArgs{
ApiKey: pulumi.String("string"),
DisableFetchingPredictiveAnalytics: pulumi.Bool(false),
NumWorkers: pulumi.Float64(0),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceKlaviyoResource = new SourceKlaviyo("sourceKlaviyoResource", SourceKlaviyoArgs.builder()
    .configuration(SourceKlaviyoConfigurationArgs.builder()
        .apiKey("string")
        .disableFetchingPredictiveAnalytics(false)
        .numWorkers(0)
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_klaviyo_resource = airbyte.SourceKlaviyo("sourceKlaviyoResource",
    configuration={
        "api_key": "string",
        "disable_fetching_predictive_analytics": False,
        "num_workers": 0,
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceKlaviyoResource = new airbyte.SourceKlaviyo("sourceKlaviyoResource", {
    configuration: {
        apiKey: "string",
        disableFetchingPredictiveAnalytics: false,
        numWorkers: 0,
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceKlaviyo
properties:
    configuration:
        apiKey: string
        disableFetchingPredictiveAnalytics: false
        numWorkers: 0
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceKlaviyo Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceKlaviyo resource accepts the following input properties:

Configuration SourceKlaviyoConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceKlaviyoConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceKlaviyoConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceKlaviyoConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceKlaviyoConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceKlaviyo resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceKlaviyo Resource

Get an existing SourceKlaviyo resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceKlaviyoState, opts?: CustomResourceOptions): SourceKlaviyo

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceKlaviyoConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceKlaviyo

func GetSourceKlaviyo(ctx *Context, name string, id IDInput, state *SourceKlaviyoState, opts ...ResourceOption) (*SourceKlaviyo, error)

public static SourceKlaviyo Get(string name, Input<string> id, SourceKlaviyoState? state, CustomResourceOptions? opts = null)

public static SourceKlaviyo get(String name, Output<String> id, SourceKlaviyoState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceKlaviyo    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceKlaviyoConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceKlaviyoConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceKlaviyoConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceKlaviyoConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceKlaviyoConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceKlaviyoConfiguration, SourceKlaviyoConfigurationArgs

ApiKey string: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
DisableFetchingPredictiveAnalytics bool: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
NumWorkers double: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
StartDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

ApiKey string: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
DisableFetchingPredictiveAnalytics bool: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
NumWorkers float64: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
StartDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

apiKey String: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
disableFetchingPredictiveAnalytics Boolean: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
numWorkers Double: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
startDate String: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

apiKey string: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
disableFetchingPredictiveAnalytics boolean: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
numWorkers number: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
startDate string: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

api_key str: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
disable_fetching_predictive_analytics bool: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
num_workers float: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
start_date str: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

apiKey String: Klaviyo API Key. See our \n\ndocs\n\n if you need help finding this key.
disableFetchingPredictiveAnalytics Boolean: Certain streams like the profiles stream can retrieve predictive analytics data from Klaviyo's API. However, at high volume, this can lead to service availability issues on the API which can be improved by not fetching this field. WARNING: Enabling this setting will stop the "predictive_analytics" column from being populated in your downstream destination.
numWorkers Number: The number of worker threads to use for the sync. The performance upper boundary is based on the limit of your Klaviyo plan. More info about the rate limit plan tiers can be found on Klaviyo's API \n\ndocs\n\n. Default: 10
startDate String: UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. This field is optional - if not provided, all data will be replicated.

Import

$ pulumi import airbyte:index/sourceKlaviyo:SourceKlaviyo my_airbyte_source_klaviyo ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceKlaviyo

On this page

On this page

Example Usage

Create SourceKlaviyo Resource

Constructor syntax

Parameters

Constructor example

SourceKlaviyo Resource Properties

Inputs

Outputs

Look up Existing SourceKlaviyo Resource

Supporting Types

SourceKlaviyoConfiguration, SourceKlaviyoConfigurationArgs

Import

Package Details

On this page

On this page