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.6 KB
Raw Blame
from typing import Optional, cast

from products.warehouse_sources.sources.sdk import (
    NOT_DETECTABLE,
    CanonicalDescriptions,
    DataWarehouseSourceCategory,
    ExternalDataSourceType,
    FieldType,
    ReleaseStatus,
    ResumableSource,
    ResumableSourceManager,
    SourceConfig,
    SourceFieldInputConfig,
    SourceFieldInputConfigType,
    SourceInputs,
    SourceRegistry,
    SourceResponse,
    SourceSchema,
    build_endpoint_schemas,
)
from products.warehouse_sources.sources.zero._config import ZeroSourceConfig
from products.warehouse_sources.sources.zero.settings import ENDPOINTS, INCREMENTAL_FIELDS
from products.warehouse_sources.sources.zero.zero import (
    ZeroResumeConfig,
    validate_credentials as validate_zero_credentials,
    zero_source,
)


@SourceRegistry.register
class ZeroSource(ResumableSource[ZeroSourceConfig, ZeroResumeConfig]):
    codebase_detection = NOT_DETECTABLE

    lists_tables_without_credentials = True  # static endpoint catalog — safe for public docs
    api_docs_url = "https://docs.zero.inc/features/api"

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

    def get_non_retryable_errors(self) -> dict[str, str | None]:
        return {
            "401 Client Error": "Your Zero API key is invalid or has been revoked. Generate a new key in workspace settings and reconnect.",
            "403 Client Error": "Your Zero API key is invalid or has been revoked. Generate a new key in workspace settings and reconnect.",
        }

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

        return CANONICAL_DESCRIPTIONS

    def get_schemas(
        self,
        config: ZeroSourceConfig,
        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: ZeroSourceConfig,
        team_id: int,
        schema_name: Optional[str] = None,
        api_version: str | None = None,
    ) -> tuple[bool, str | None]:
        if validate_zero_credentials(config.api_key):
            return True, None
        return False, "Invalid API key. Check that you copied it from Workspace settings > API keys."

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

    def source_for_pipeline(
        self,
        config: ZeroSourceConfig,
        resumable_source_manager: ResumableSourceManager[ZeroResumeConfig],
        inputs: SourceInputs,
    ) -> SourceResponse:
        resource = zero_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,
            incremental_field=inputs.incremental_field,
            db_incremental_field_last_value=inputs.db_incremental_field_last_value
            if inputs.should_use_incremental_field
            else None,
        )
        return SourceResponse(
            name=resource.name,
            items=lambda: resource,
            primary_keys=["id"],
            column_hints=resource.column_hints,
        )

    @property
    def get_source_config(self) -> SourceConfig:
        return SourceConfig(
            name=ExternalDataSourceType.ZERO,
            category=DataWarehouseSourceCategory.CRM,
            releaseStatus=ReleaseStatus.GA,
            label="Zero",
            caption="Connect Zero to sync companies, contacts, deals, and activity into your warehouse. "
            "Create an API key at [Workspace settings > API keys](https://app.zero.inc/settings/workspace/api).",
            docsUrl="https://posthog.com/docs/cdp/sources/zero",
            iconPath="/static/services/zero.png",
            fields=cast(
                list[FieldType],
                [
                    SourceFieldInputConfig(
                        name="api_key",
                        label="API key",
                        type=SourceFieldInputConfigType.PASSWORD,
                        required=True,
                        placeholder="",
                        secret=True,
                    ),
                ],
            ),
        )