provider external_data_sources POST /api/projects/{project_id}/external_data_sources/{id}/check_cdc_prerequisites_for_source/
@utdk/posthog /api/projects/{project_id}/external_data_sources/{id}/check_cdc_prerequisites_for_source/
external_data_sources_check_cdc_prerequisites_for_source_create
Validate CDC prerequisites for an existing source using its stored credentials. The detail=False ``check_cdc_prerequisites`` action is for the creation wizard, where the client still holds the raw connection config (incl. password) in the form. On the Configuration page the source already exists and secret fields are stripped from API responses — so the client can't supply them. This reads the stored (encrypted) credentials from the DB via the adapter instead. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), ``cdc_slot_name`` (optional), ``cdc_publication_name`` (optional).
id path required
A UUID string identifying this external data source.
string
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string

Try it

Authentication
Configure credentials for PostHog API
externalDataSourcesCheckCdcPrerequisitesForSourceCreate
POST/api/projects/{project_id}/external_data_sources/{id}/check_cdc_prerequisites_for_source/
Validate CDC prerequisites for an existing source using its stored credentials. The detail=False ``check_cdc_prerequisites`` action is for the creation wizard, where the client still holds the raw connection config (incl. password) in the form. On the Configuration page the source already exists and secret fields are stripped from API responses — so the client can't supply them. This reads the stored (encrypted) credentials from the DB via the adapter instead. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), ``cdc_slot_name`` (optional), ``cdc_publication_name`` (optional).

Parameters

required

A UUID string identifying this external data source.

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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.externalDataSourcesCheckCdcPrerequisitesForSourceCreate()