How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog external_data_sources API

The external_data_sources API from PostHog — 32 operation(s) for external_data_sources.

PostHog external_data_sources API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 40 operations across 32 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

40 operations 32 paths 21 schemas 2 DELETE12 GET6 PATCH18 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog external_data_sources API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 40

Across 32 paths, the API surfaces 40 operations — 2 DELETE, 12 GET, 6 PATCH, 18 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

external_data_sources 40
GET
/api/environments/{environment_id}/external_data_sources/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_list 4 params → 200
POST
/api/environments/{environment_id}/external_data_sources/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_create 1 param body → 201
GET
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_update 2 params body → 200
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/external_data_sources/{id}/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_destroy 2 params → 204
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/bulk_update_schemas/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_bulk_update_schemas_partial_update 5 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/create_webhook/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_create_webhook_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/delete_webhook/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_delete_webhook_create 2 params body → 200
GET
/api/environments/{environment_id}/external_data_sources/{id}/jobs/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_jobs_retrieve 2 params → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/refresh_schemas/deprecated
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
environments_external_data_sources_refresh_schemas_create 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/reload/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_reload_create 2 params body → 200
PATCH
/api/environments/{environment_id}/external_data_sources/{id}/revenue_analytics_config/deprecated
Update the revenue analytics configuration and return the full external data source.
environments_external_data_sources_revenue_analytics_config_partial_update 2 params body → 200
POST
/api/environments/{environment_id}/external_data_sources/{id}/update_webhook_inputs/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_update_webhook_inputs_create 2 params body → 200
GET
/api/environments/{environment_id}/external_data_sources/{id}/webhook_info/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_webhook_info_retrieve 2 params → 200
POST
/api/environments/{environment_id}/external_data_sources/check_cdc_prerequisites/deprecated
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 publi…
environments_external_data_sources_check_cdc_prerequisites_create 1 param → 200400
GET
/api/environments/{environment_id}/external_data_sources/connections/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_connections_list 4 params → 200
POST
/api/environments/{environment_id}/external_data_sources/database_schema/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_database_schema_create 1 param body → 200
POST
/api/environments/{environment_id}/external_data_sources/source_prefix/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_source_prefix_create 1 param body → 200
GET
/api/environments/{environment_id}/external_data_sources/wizard/deprecated
Create, Read, Update and Delete External data Sources.
environments_external_data_sources_wizard_retrieve 1 param → 200
GET
/api/projects/{project_id}/external_data_sources/
Create, Read, Update and Delete External data Sources.
external_data_sources_list 4 params → 200
POST
/api/projects/{project_id}/external_data_sources/
Create, Read, Update and Delete External data Sources.
external_data_sources_create 1 param body → 201
GET
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_retrieve 2 params → 200
PUT
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_update 2 params body → 200
PATCH
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/external_data_sources/{id}/
Create, Read, Update and Delete External data Sources.
external_data_sources_destroy 2 params → 204
PATCH
/api/projects/{project_id}/external_data_sources/{id}/bulk_update_schemas/
Create, Read, Update and Delete External data Sources.
external_data_sources_bulk_update_schemas_partial_update 5 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/create_webhook/
Create, Read, Update and Delete External data Sources.
external_data_sources_create_webhook_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/delete_webhook/
Create, Read, Update and Delete External data Sources.
external_data_sources_delete_webhook_create 2 params body → 200
GET
/api/projects/{project_id}/external_data_sources/{id}/jobs/
Create, Read, Update and Delete External data Sources.
external_data_sources_jobs_retrieve 2 params → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/refresh_schemas/
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
external_data_sources_refresh_schemas_create 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/reload/
Create, Read, Update and Delete External data Sources.
external_data_sources_reload_create 2 params body → 200
PATCH
/api/projects/{project_id}/external_data_sources/{id}/revenue_analytics_config/
Update the revenue analytics configuration and return the full external data source.
external_data_sources_revenue_analytics_config_partial_update 2 params body → 200
POST
/api/projects/{project_id}/external_data_sources/{id}/update_webhook_inputs/
Create, Read, Update and Delete External data Sources.
external_data_sources_update_webhook_inputs_create 2 params body → 200
GET
/api/projects/{project_id}/external_data_sources/{id}/webhook_info/
Create, Read, Update and Delete External data Sources.
external_data_sources_webhook_info_retrieve 2 params → 200
POST
/api/projects/{project_id}/external_data_sources/check_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 publi…
external_data_sources_check_cdc_prerequisites_create 1 param → 200400
GET
/api/projects/{project_id}/external_data_sources/connections/
Create, Read, Update and Delete External data Sources.
external_data_sources_connections_list 4 params → 200
POST
/api/projects/{project_id}/external_data_sources/database_schema/
Create, Read, Update and Delete External data Sources.
external_data_sources_database_schema_create 1 param body → 200
POST
/api/projects/{project_id}/external_data_sources/source_prefix/
Create, Read, Update and Delete External data Sources.
external_data_sources_source_prefix_create 1 param body → 200
GET
/api/projects/{project_id}/external_data_sources/wizard/
Create, Read, Update and Delete External data Sources.
external_data_sources_wizard_retrieve 1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are PatchedExternalDataSourceSerializers (19 properties), ExternalDataSourceSerializers (19 properties), ExternalDataSchema (17 properties), ExternalDataSourceBulkUpdateSchema (8 properties). Each schema is shown below with its type and property counts.

DatabaseSchemaRequest
object
Validate credentials and preview available tables from a remote database. The request body contains sourcetype plus flat source-specific credential fields (e.g…
1 property 1 required
CdcTableModeEnum
string
consolidated - consolidated cdconly - cdconly both - both
NullEnum
ExternalDataSourceTypeEnum
string
Ashby - Ashby Supabase - Supabase CustomerIO - CustomerIO Github - Github Stripe - Stripe Hubspot - Hubspot Postgres - Postgres Zendesk - Zendesk Snowflake - S…
SyncFrequencyEnum
string
never - never 1min - 1min 5min - 5min 15min - 15min 30min - 30min 1hour - 1hour 6hour - 6hour 12hour - 12hour 24hour - 24hour 7day - 7day 30day - 30day
ExternalDataSourceSerializers
object
Mixin for serializers to add user access control fields
19 properties 15 required
PaginatedExternalDataSchemaList
object
4 properties 2 required
PatchedExternalDataSourceBulkUpdateSchemas
object
1 property
ExternalDataSourceConnectionOption
object
3 properties 3 required
ExternalDataSourceCreate
object
6 properties 2 required
ExternalDataSourceBulkUpdateSchema
object
8 properties 1 required
AccessMethodEnum
string
warehouse - warehouse direct - direct
IncrementalFieldTypeEnum
string
integer - integer numeric - numeric datetime - datetime date - date timestamp - timestamp objectid - objectid
ExternalDataSourceRevenueAnalyticsConfig
object
2 properties
PaginatedExternalDataSourceSerializersList
object
4 properties 2 required
EngineEnum
string
duckdb - duckdb postgres - postgres
PatchedExternalDataSourceSerializers
object
Mixin for serializers to add user access control fields
19 properties
SyncTypeEnum
string
fullrefresh - fullrefresh incremental - incremental append - append webhook - webhook cdc - cdc
PaginatedExternalDataSourceConnectionOptionList
object
4 properties 2 required
ExternalDataSchema
object
17 properties 9 required
CreatedViaEnum
string
web - web api - api mcp - mcp

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-external-data-sources-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog external_data_sources API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.