External Data
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
POST | |
PATCH | |
POST | |
POST | |
GET | |
POST | |
GET | |
POST | |
POST | |
GET |
Create external data sources reload
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /projects /:project_id /external_data_sources /:id /reloadExample response
Status 200 No response body
Update external data sources revenue analytics config
Update the revenue analytics configuration and return the full external data source.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
PATCH /api /projects /:project_id /external_data_sources /:id /revenue_analytics_configExample response
Status 200 No response body
Create external data sources update cdc settings
Update CDC tuning fields without enabling/disabling.
Lets users edit cdc_auto_drop_slot, cdc_lag_warning_threshold_mb, and
cdc_lag_critical_threshold_mb independently. These fields are universal
across engines. Engine-specific identifiers (slot name, management mode, …)
are immutable post-enable — switching them requires disable + enable.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /projects /:project_id /external_data_sources /:id /update_cdc_settingsExample response
Status 200 No response body
Create external data sources update webhook inputs
Also available via the PostHog MCP server:
external-data-sources-update-webhook-inputs-create— Update webhook inputs (signing secret, etc.)
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writePath parameters
- idstring
Request parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /projects /:project_id /external_data_sources /:id /update_webhook_inputsExample response
Status 200 No response body
Retrieve external data sources webhook info
Also available via the PostHog MCP server:
external-data-sources-webhook-info-retrieve— Get webhook status for a source
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readPath parameters
- idstring
Example request
GET /api /projects /:project_id /external_data_sources /:id /webhook_infoExample response
Status 200 No response body
Create external data sources check cdc prerequisites
Also available via the PostHog MCP server:
external-data-sources-check-cdc-prerequisites-create— Check Postgres CDC prerequisites
Validate CDC prerequisites against a live Postgres connection.
Used by the source wizard to surface ✅/❌ checks before source creation, and by the self-managed setup popup to verify user-created publications.
Required API key scopes
external_data_source:writeExample request
POST /api /projects /:project_id /external_data_sources /check_cdc_prerequisitesExample response
Status 200 Whether the Postgres database satisfies CDC prerequisites.
Status 400 Invalid config, disallowed host, or connection failure.
List all external data sources connections
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readQuery parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /projects /:project_id /external_data_sources /connectionsExample response
Status 200
Create external data sources database schema
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writeRequest parameters
- source_type
Example request
POST /api /projects /:project_id /external_data_sources /database_schemaExample response
Status 200 No response body
Create external data sources source prefix
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:writeRequest parameters
- created_via
- client_secretstring
- account_idstring
- prefixstringnull
- descriptionstringnull
- job_inputs
Example request
POST /api /projects /:project_id /external_data_sources /source_prefixExample response
Status 200 No response body
Retrieve external data sources wizard
Create, Read, Update and Delete External data Sources.
Required API key scopes
external_data_source:readExample request
GET /api /projects /:project_id /external_data_sources /wizard