External Data API Reference

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`

← Previous page

Create external data sources reload

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Path parameters

id
string

Request parameters

created_via
client_secret
string
account_id
string
prefix
stringnull
description
stringnull
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/:id/reload
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/:id/reload/\
	-d client_secret="string",\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{external_data_sources-3_id}/reload/".format(
        project_id=project_id,
		external_data_sources-3_id="<the external data sources-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()

Example 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:write

Path parameters

id
string

Request parameters

created_via
client_secret
string
account_id
string
prefix
stringnull
description
stringnull
job_inputs

Example request

PATCH /api/projects/:project_id/external_data_sources/:id/revenue_analytics_config
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/:id/revenue_analytics_config/\
	-d created_at="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{external_data_sources-3_id}/revenue_analytics_config/".format(
        project_id=project_id,
		external_data_sources-3_id="<the external data sources-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"created_at": "string"
	}
).json()

Example 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:write

Path parameters

id
string

Request parameters

created_via
client_secret
string
account_id
string
prefix
stringnull
description
stringnull
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/:id/update_cdc_settings
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/:id/update_cdc_settings/\
	-d client_secret="string",\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{external_data_sources-3_id}/update_cdc_settings/".format(
        project_id=project_id,
		external_data_sources-3_id="<the external data sources-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()

Example 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:write

Path parameters

id
string

Request parameters

created_via
client_secret
string
account_id
string
prefix
stringnull
description
stringnull
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/:id/update_webhook_inputs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/:id/update_webhook_inputs/\
	-d client_secret="string",\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{external_data_sources-3_id}/update_webhook_inputs/".format(
        project_id=project_id,
		external_data_sources-3_id="<the external data sources-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()

Example 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:read

Path parameters

id
string

Example request

GET /api/projects/:project_id/external_data_sources/:id/webhook_info
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/:id/webhook_info/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/{external_data_sources-3_id}/webhook_info/".format(
        project_id=project_id,
		external_data_sources-3_id="<the external data sources-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example 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:write

Example request

POST /api/projects/:project_id/external_data_sources/check_cdc_prerequisites
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/check_cdc_prerequisites/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/check_cdc_prerequisites/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example 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:read

Query parameters

limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/external_data_sources/connections
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/connections/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/connections/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "prefix": "string",
      "engine": "duckdb"
    }
  ]
}

Create external data sources database schema

Create, Read, Update and Delete External data Sources.

Required API key scopes

external_data_source:write

Request parameters

source_type

Example request

POST /api/projects/:project_id/external_data_sources/database_schema
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/database_schema/\
	-d source_type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/database_schema/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example 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:write

Request parameters

created_via
client_secret
string
account_id
string
prefix
stringnull
description
stringnull
job_inputs

Example request

POST /api/projects/:project_id/external_data_sources/source_prefix
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/source_prefix/\
	-d client_secret="string",\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/source_prefix/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"client_secret": "string",
		"account_id": "string"
	}
).json()

Example 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:read

Example request

GET /api/projects/:project_id/external_data_sources/wizard
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_sources/wizard/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/external_data_sources/wizard/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

← Previous page

External Data

Endpoints

Create external data sources reload

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Update external data sources revenue analytics config

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create external data sources update cdc settings

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create external data sources update webhook inputs

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve external data sources webhook info

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create external data sources check cdc prerequisites

Required API key scopes

Example request

Example 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

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create external data sources database schema

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Create external data sources source prefix

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Retrieve external data sources wizard

Required API key scopes

Example request

Example response

Status 200 No response body

Community questions