Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

4.7 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.convertkit._config import ConvertKitSourceConfig
from products.warehouse_sources.sources.convertkit.convertkit import (
    ConvertKitResumeConfig,
    convertkit_source,
    validate_credentials as validate_convertkit_credentials,
)
from products.warehouse_sources.sources.convertkit.settings import ENDPOINTS, INCREMENTAL_FIELDS
from products.warehouse_sources.sources.sdk import (
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    ResumableSource,
    ResumableSourceManager,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
    detect,
)


@SourceRegistry.register
class ConvertKitSource(ResumableSource[ConvertKitSourceConfig, ConvertKitResumeConfig]):
    codebase_detection = detect(env=("^CONVERTKIT_",), script_hosts=("f.convertkit.com",))

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs

    supported_versions = ("v4",)
    default_version = "v4"
    api_docs_url = "https://developers.kit.com/"

    @property
    def source_type(self) -> ExternalDataSourceType:
        return ExternalDataSourceType.CONVERTKIT

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.CONVERTKIT,
            category=DataWarehouseSourceCategory.MARKETING___EMAIL,
            keywords=["kit"],
            label="ConvertKit",
            caption="""Enter your Kit (formerly ConvertKit) API key to pull your Kit data into the PostHog Data warehouse.

You can create a v4 API key in your [Kit account settings](https://app.kit.com/account_settings/developer_settings).""",
            iconPath="/static/services/convertkit.png",
            docsUrl="https://posthog.com/docs/cdp/sources/convertkit",
            releaseStatus=ReleaseStatus.GA,
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API key",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="kit_...",
                        secret=True,
                    ),
                ],
            ),
        )

    def get_canonical_descriptions(self) -> CanonicalDescriptions:
        from products.warehouse_sources.sources.convertkit.canonical_descriptions import CANONICAL_DESCRIPTIONS

        return CANONICAL_DESCRIPTIONS

    def get_schemas(
        self,
        config: ConvertKitSourceConfig,
        team_id: int,
        with_counts: bool = False,
        names: list[str] | None = None,
        force_refresh: bool = False,
        api_version: str | None = None,
    ) -> list[SourceSchema]:
        return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names)

    def validate_credentials(
        self,
        config: ConvertKitSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        return validate_convertkit_credentials(config.api_key, schema_name)

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            "401 Client Error: Unauthorized for url: https://api.kit.com": "Your Kit API key is invalid or expired. Please generate a new key and reconnect.",
            "403 Client Error: Forbidden for url: https://api.kit.com": "Your Kit API key does not have the required permissions. Please check the key and try again.",
        }

    def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[ConvertKitResumeConfig]:
        return ResumableSourceManager[ConvertKitResumeConfig](inputs, ConvertKitResumeConfig)

    def source_for_pipeline(
        self,
        config: ConvertKitSourceConfig,
        resumable_source_manager: ResumableSourceManager[ConvertKitResumeConfig],
        inputs: SourceInputs,
    ) -> SourceResponse:
        return convertkit_source(
            api_key=config.api_key,
            endpoint=inputs.schema_name,
            team_id=inputs.team_id,
            job_id=inputs.job_id,
            resumable_source_manager=resumable_source_manager,
            should_use_incremental_field=inputs.should_use_incremental_field,
            db_incremental_field_last_value=inputs.db_incremental_field_last_value
            if inputs.should_use_incremental_field
            else None,
            incremental_field=inputs.incremental_field,
        )