Skip to main content

Airbyte Klaviyo Connector for AI platforms

Project description

Klaviyo agent connector

Klaviyo is a marketing automation platform that helps businesses build customer relationships through personalized email, SMS, and push notifications. This connector provides access to Klaviyo's core entities including profiles, lists, campaigns, events, metrics, flows, and email templates for marketing analytics and customer engagement insights.

Example questions

The Klaviyo connector is optimized to handle prompts like these.

  • List all profiles in my Klaviyo account
  • Show me details for a recent profile
  • Show me all email lists
  • Show me details for a recent email list
  • What campaigns have been created?
  • Show me details for a recent campaign
  • Show me all email campaigns
  • List all events for tracking customer actions
  • Show me all metrics (event types)
  • Show me details for a recent metric
  • What automated flows are configured?
  • Show me details for a recent flow
  • List all email templates
  • Show me details for a recent email template

Unsupported questions

The Klaviyo connector isn't currently able to handle prompts like these.

  • Create a new profile
  • Update a profile's email address
  • Delete a list
  • Send an email campaign
  • Add a profile to a list

Installation

uv pip install airbyte-agent-klaviyo

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_klaviyo import KlaviyoConnector
from airbyte_agent_klaviyo.models import KlaviyoAuthConfig

connector = KlaviyoConnector(
    auth_config=KlaviyoAuthConfig(
        api_key="<Your Klaviyo private API key>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@KlaviyoConnector.tool_utils
async def klaviyo_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_klaviyo import KlaviyoConnector, AirbyteAuthConfig

connector = KlaviyoConnector(
    auth_config=AirbyteAuthConfig(
        external_user_id="<your_external_user_id>",
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@KlaviyoConnector.tool_utils
async def klaviyo_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Profiles List, Get, Search
Lists List, Get, Search
Campaigns List, Get, Search
Events List, Search
Metrics List, Get, Search
Flows List, Get, Search
Email Templates List, Get, Search

Authentication and configuration

For all authentication and configuration options, see the connector's authentication documentation.

Klaviyo API docs

See the official Klaviyo API reference.

Version information

  • Package version: 0.1.23
  • Connector version: 1.0.2
  • Generated with Connector SDK commit SHA: df1e8094b5b2d94e172536ce7f33fb98f2c3fdc1
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_klaviyo-0.1.23.tar.gz (136.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_klaviyo-0.1.23-py3-none-any.whl (162.3 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_klaviyo-0.1.23.tar.gz.

File metadata

  • Download URL: airbyte_agent_klaviyo-0.1.23.tar.gz
  • Upload date:
  • Size: 136.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for airbyte_agent_klaviyo-0.1.23.tar.gz
Algorithm Hash digest
SHA256 1ed3745d42295325622dcea0ce295611008485fc3f06d9e195ac1f02a6f49cdd
MD5 718f733b6ace6d6b1974cb591bb3a2fb
BLAKE2b-256 e73ab6ad912ba345be24fa473c005a34324edceedf72012156e419ef5fe313d5

See more details on using hashes here.

File details

Details for the file airbyte_agent_klaviyo-0.1.23-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_klaviyo-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 3ff706bd07b1cac47e5cebb0335d462d98af4841608b6855d7cf8267febc64f4
MD5 bc607e026ea17e5e1d371d6345487896
BLAKE2b-256 cf2b983515dcfec4971fdac54240c7e7ce0c8d43158fd5a3c76863db47ea2892

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page