: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.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
from typing import Optional, cast
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,
)
from products.warehouse_sources.sources.sequenzy._config import SequenzySourceConfig
from products.warehouse_sources.sources.sequenzy.sequenzy import (
SequenzyResumeConfig,
sequenzy_source,
validate_credentials as validate_sequenzy_credentials,
)
from products.warehouse_sources.sources.sequenzy.settings import ENDPOINTS, INCREMENTAL_FIELDS, MERGE_ONLY_ENDPOINTS
@SourceRegistry.register
class SequenzySource(ResumableSource[SequenzySourceConfig, SequenzyResumeConfig]):
codebase_detection = detect(env=("^SEQUENZY_",), npm=("sequenzy",))
lists_tables_without_credentials = True # static endpoint catalog, safe for public docs
api_docs_url = "https://docs.sequenzy.com/api-reference"
@property
def source_type(self) -> ExternalDataSourceType:
return ExternalDataSourceType.SEQUENZY
def get_non_retryable_errors(self) -> dict[str, str | None]:
return {
"401 Client Error: Unauthorized for url": "Your Sequenzy API key is invalid or was revoked. Create a new key in Sequenzy under Settings > API Keys and update the source.",
"403 Client Error: Forbidden for url": "Your Sequenzy API key does not have access to this data. Check the key's permissions and the company ID, then try again.",
}
def get_canonical_descriptions(self) -> CanonicalDescriptions:
from products.warehouse_sources.sources.sequenzy.canonical_descriptions import CANONICAL_DESCRIPTIONS
return CANONICAL_DESCRIPTIONS
def get_schemas(
self,
config: SequenzySourceConfig,
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, merge_only=MERGE_ONLY_ENDPOINTS)
def validate_credentials(
self,
config: SequenzySourceConfig,
team_id: int,
schema_name: Optional[str] = None,
api_version: str | None = None,
) -> tuple[bool, str | None]:
return validate_sequenzy_credentials(config.api_key, config.company_id)
def get_resumable_source_manager(self, inputs: SourceInputs) -> ResumableSourceManager[SequenzyResumeConfig]:
return ResumableSourceManager[SequenzyResumeConfig](inputs, SequenzyResumeConfig)
def source_for_pipeline(
self,
config: SequenzySourceConfig,
resumable_source_manager: ResumableSourceManager[SequenzyResumeConfig],
inputs: SourceInputs,
) -> SourceResponse:
return sequenzy_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,
company_id=config.company_id,
should_use_incremental_field=inputs.should_use_incremental_field,
db_incremental_field_last_value=inputs.db_incremental_field_last_value,
)
@property
def get_source_config(self) -> SourceConfig:
return SourceConfig(
name=ExternalDataSourceType.SEQUENZY,
category=DataWarehouseSourceCategory.MARKETING___EMAIL,
label="Sequenzy",
caption=(
"Create an API key in Sequenzy under **Workspace Settings > API Keys** with read "
"access to subscribers, tags, lists, segments, campaigns, sequences, and analytics."
),
docsUrl="https://posthog.com/docs/cdp/sources/sequenzy",
iconPath="/static/services/sequenzy.png",
keywords=["email marketing", "newsletter"],
releaseStatus=ReleaseStatus.GA,
fields=cast(
list[FieldType],
[
SourceFieldInputConfig(
name="api_key",
label="API key",
type=SourceFieldInputConfigType.PASSWORD,
required=True,
placeholder="seq_live_...",
secret=True,
),
SourceFieldInputConfig(
name="company_id",
label="Company ID",
caption=(
"Only needed with an account API key (starts with `seq_user_`): the ID of "
"the Sequenzy workspace to sync. Workspace keys (`seq_live_`) already "
"belong to one workspace."
),
type=SourceFieldInputConfigType.TEXT,
required=False,
placeholder="",
secret=False,
),
],
),
)