provider external_data_sources POST /api/environments/{environment_id}/external_data_sources/{id}/enable_cdc/
@utdk/posthog /api/environments/{environment_id}/external_data_sources/{id}/enable_cdc/
environments_external_data_sources_enable_cdc_create
Enable CDC on an existing source. Provisions engine-side CDC resources via the source's adapter, writes the CDC config into ``source.job_inputs``, and ensures the CDC extraction schedule exists. Re-runs prereq checks server-side so we never trust a stale client-side check. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), plus engine-specific identifier hints (e.g. ``cdc_slot_name``, ``cdc_publication_name`` for Postgres). Universal tuning fields: ``cdc_auto_drop_slot`` (optional bool), ``cdc_lag_warning_threshold_mb`` (optional int), ``cdc_lag_critical_threshold_mb`` (optional int).
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this external data source.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsExternalDataSourcesEnableCdcCreate
POST/api/environments/{environment_id}/external_data_sources/{id}/enable_cdc/
Enable CDC on an existing source. Provisions engine-side CDC resources via the source's adapter, writes the CDC config into ``source.job_inputs``, and ensures the CDC extraction schedule exists. Re-runs prereq checks server-side so we never trust a stale client-side check. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), plus engine-specific identifier hints (e.g. ``cdc_slot_name``, ``cdc_publication_name`` for Postgres). Universal tuning fields: ``cdc_auto_drop_slot`` (optional bool), ``cdc_lag_warning_threshold_mb`` (optional int), ``cdc_lag_critical_threshold_mb`` (optional int).

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this external data source.

Input

required
required
required

How this source was created. Defaults to `api` on create when omitted. `web` for the in-app UI, `api` for direct API callers, `mcp` for agent/MCP tool calls. Ignored on update. * `web` - web * `api` - api * `mcp` - mcp

required
required
required
required
required
required

Whether this synced source is also live-queryable via direct connection. Defaults to true for new sources; ignored for pure direct-query sources.

required

Backend engine detected for the direct connection. * `duckdb` - duckdb * `postgres` - postgres * `mysql` - mysql * `snowflake` - snowflake

required
required
required
required

The effective access level the user has for this object

required
required

Whether this source supports per-column sync selection via `enabled_columns`.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsExternalDataSourcesEnableCdcCreate()