PostHog API — external_data_sources

naftiko: 1.0.0-alpha2
info:
  label: PostHog API — external_data_sources
  description: 'PostHog API — external_data_sources. 40 operations. Lead operation: external_data_sources. Self-contained
    Naftiko capability covering one Posthog business surface.'
  tags:
  - Posthog
  - external_data_sources
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTHOG_API_KEY: POSTHOG_API_KEY
capability:
  consumes:
  - type: http
    namespace: posthog-external-data-sources
    baseUri: ''
    description: PostHog API — external_data_sources business capability. Self-contained, no shared references.
    resources:
    - name: api-environments-environment_id-external_data_sources
      path: /api/environments/{environment_id}/external_data_sources/
      operations:
      - name: environmentsexternaldatasourceslist
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
      - name: environmentsexternaldatasourcescreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-check_cdc_prerequisites
      path: /api/environments/{environment_id}/external_data_sources/check_cdc_prerequisites/
      operations:
      - name: environmentsexternaldatasourcescheckcdcprerequisitescreate
        method: POST
        description: Validate CDC prerequisites against a live Postgres connection.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-environments-environment_id-external_data_sources-connections
      path: /api/environments/{environment_id}/external_data_sources/connections/
      operations:
      - name: environmentsexternaldatasourcesconnectionslist
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
    - name: api-environments-environment_id-external_data_sources-database_schema
      path: /api/environments/{environment_id}/external_data_sources/database_schema/
      operations:
      - name: environmentsexternaldatasourcesdatabaseschemacreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-source_prefix
      path: /api/environments/{environment_id}/external_data_sources/source_prefix/
      operations:
      - name: environmentsexternaldatasourcessourceprefixcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-wizard
      path: /api/environments/{environment_id}/external_data_sources/wizard/
      operations:
      - name: environmentsexternaldatasourceswizardretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-environments-environment_id-external_data_sources-id
      path: /api/environments/{environment_id}/external_data_sources/{id}/
      operations:
      - name: environmentsexternaldatasourcesretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
      - name: environmentsexternaldatasourcesupdate
        method: PUT
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: environmentsexternaldatasourcespartialupdate
        method: PATCH
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsexternaldatasourcesdestroy
        method: DELETE
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    - name: api-environments-environment_id-external_data_sources-id-bulk_update_schemas
      path: /api/environments/{environment_id}/external_data_sources/{id}/bulk_update_schemas/
      operations:
      - name: environmentsexternaldatasourcesbulkupdateschemaspartialupdate
        method: PATCH
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-external_data_sources-id-create_webhook
      path: /api/environments/{environment_id}/external_data_sources/{id}/create_webhook/
      operations:
      - name: environmentsexternaldatasourcescreatewebhookcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-id-delete_webhook
      path: /api/environments/{environment_id}/external_data_sources/{id}/delete_webhook/
      operations:
      - name: environmentsexternaldatasourcesdeletewebhookcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-id-jobs
      path: /api/environments/{environment_id}/external_data_sources/{id}/jobs/
      operations:
      - name: environmentsexternaldatasourcesjobsretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    - name: api-environments-environment_id-external_data_sources-id-refresh_schemas
      path: /api/environments/{environment_id}/external_data_sources/{id}/refresh_schemas/
      operations:
      - name: environmentsexternaldatasourcesrefreshschemascreate
        method: POST
        description: Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-id-reload
      path: /api/environments/{environment_id}/external_data_sources/{id}/reload/
      operations:
      - name: environmentsexternaldatasourcesreloadcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-id-revenue_analytics_confi
      path: /api/environments/{environment_id}/external_data_sources/{id}/revenue_analytics_config/
      operations:
      - name: environmentsexternaldatasourcesrevenueanalyticsconfigpartialupdate
        method: PATCH
        description: Update the revenue analytics configuration and return the full external data source.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-external_data_sources-id-update_webhook_inputs
      path: /api/environments/{environment_id}/external_data_sources/{id}/update_webhook_inputs/
      operations:
      - name: environmentsexternaldatasourcesupdatewebhookinputscreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-external_data_sources-id-webhook_info
      path: /api/environments/{environment_id}/external_data_sources/{id}/webhook_info/
      operations:
      - name: environmentsexternaldatasourceswebhookinforetrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    - name: api-projects-project_id-external_data_sources
      path: /api/projects/{project_id}/external_data_sources/
      operations:
      - name: externaldatasourceslist
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
      - name: externaldatasourcescreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-check_cdc_prerequisites
      path: /api/projects/{project_id}/external_data_sources/check_cdc_prerequisites/
      operations:
      - name: externaldatasourcescheckcdcprerequisitescreate
        method: POST
        description: Validate CDC prerequisites against a live Postgres connection.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-project_id-external_data_sources-connections
      path: /api/projects/{project_id}/external_data_sources/connections/
      operations:
      - name: externaldatasourcesconnectionslist
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
    - name: api-projects-project_id-external_data_sources-database_schema
      path: /api/projects/{project_id}/external_data_sources/database_schema/
      operations:
      - name: externaldatasourcesdatabaseschemacreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-source_prefix
      path: /api/projects/{project_id}/external_data_sources/source_prefix/
      operations:
      - name: externaldatasourcessourceprefixcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-wizard
      path: /api/projects/{project_id}/external_data_sources/wizard/
      operations:
      - name: externaldatasourceswizardretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-project_id-external_data_sources-id
      path: /api/projects/{project_id}/external_data_sources/{id}/
      operations:
      - name: externaldatasourcesretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
      - name: externaldatasourcesupdate
        method: PUT
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: externaldatasourcespartialupdate
        method: PATCH
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: externaldatasourcesdestroy
        method: DELETE
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    - name: api-projects-project_id-external_data_sources-id-bulk_update_schemas
      path: /api/projects/{project_id}/external_data_sources/{id}/bulk_update_schemas/
      operations:
      - name: externaldatasourcesbulkupdateschemaspartialupdate
        method: PATCH
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: search
          in: query
          type: string
          description: A search term.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-external_data_sources-id-create_webhook
      path: /api/projects/{project_id}/external_data_sources/{id}/create_webhook/
      operations:
      - name: externaldatasourcescreatewebhookcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-id-delete_webhook
      path: /api/projects/{project_id}/external_data_sources/{id}/delete_webhook/
      operations:
      - name: externaldatasourcesdeletewebhookcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-id-jobs
      path: /api/projects/{project_id}/external_data_sources/{id}/jobs/
      operations:
      - name: externaldatasourcesjobsretrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    - name: api-projects-project_id-external_data_sources-id-refresh_schemas
      path: /api/projects/{project_id}/external_data_sources/{id}/refresh_schemas/
      operations:
      - name: externaldatasourcesrefreshschemascreate
        method: POST
        description: Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-id-reload
      path: /api/projects/{project_id}/external_data_sources/{id}/reload/
      operations:
      - name: externaldatasourcesreloadcreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-id-revenue_analytics_config
      path: /api/projects/{project_id}/external_data_sources/{id}/revenue_analytics_config/
      operations:
      - name: externaldatasourcesrevenueanalyticsconfigpartialupdate
        method: PATCH
        description: Update the revenue analytics configuration and return the full external data source.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-external_data_sources-id-update_webhook_inputs
      path: /api/projects/{project_id}/external_data_sources/{id}/update_webhook_inputs/
      operations:
      - name: externaldatasourcesupdatewebhookinputscreate
        method: POST
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-external_data_sources-id-webhook_info
      path: /api/projects/{project_id}/external_data_sources/{id}/webhook_info/
      operations:
      - name: externaldatasourceswebhookinforetrieve
        method: GET
        description: Create, Read, Update and Delete External data Sources.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: A UUID string identifying this external data source.
          required: true
    authentication:
      type: bearer
      token: '{{env.POSTHOG_API_KEY}}'
  exposes:
  - type: rest
    namespace: posthog-external-data-sources-rest
    port: 8080
    description: REST adapter for PostHog API — external_data_sources. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/environments/{environment-id}/external-data-sources
      name: api-environments-environment-id-external-data-sources
      description: REST surface for api-environments-environment_id-external_data_sources.
      operations:
      - method: GET
        name: environmentsexternaldatasourceslist
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourceslist
        with:
          limit: rest.limit
          offset: rest.offset
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: environmentsexternaldatasourcescreate
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourcescreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/check-cdc-prerequisites
      name: api-environments-environment-id-external-data-sources-check-cdc-prerequisites
      description: REST surface for api-environments-environment_id-external_data_sources-check_cdc_prerequisites.
      operations:
      - method: POST
        name: environmentsexternaldatasourcescheckcdcprerequisitescreate
        description: Validate CDC prerequisites against a live Postgres connection.
        call: posthog-external-data-sources.environmentsexternaldatasourcescheckcdcprerequisitescreate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/connections
      name: api-environments-environment-id-external-data-sources-connections
      description: REST surface for api-environments-environment_id-external_data_sources-connections.
      operations:
      - method: GET
        name: environmentsexternaldatasourcesconnectionslist
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourcesconnectionslist
        with:
          limit: rest.limit
          offset: rest.offset
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/database-schema
      name: api-environments-environment-id-external-data-sources-database-schema
      description: REST surface for api-environments-environment_id-external_data_sources-database_schema.
      operations:
      - method: POST
        name: environmentsexternaldatasourcesdatabaseschemacreate
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourcesdatabaseschemacreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/source-prefix
      name: api-environments-environment-id-external-data-sources-source-prefix
      description: REST surface for api-environments-environment_id-external_data_sources-source_prefix.
      operations:
      - method: POST
        name: environmentsexternaldatasourcessourceprefixcreate
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourcessourceprefixcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/wizard
      name: api-environments-environment-id-external-data-sources-wizard
      description: REST surface for api-environments-environment_id-external_data_sources-wizard.
      operations:
      - method: GET
        name: environmentsexternaldatasourceswizardretrieve
        description: Create, Read, Update and Delete External data Sources.
        call: posthog-external-data-sources.environmentsexternaldatasourceswizardretrieve
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/external-data-sources/{id}
      name: api-environments-environm

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/capabilities/posthog-external-data-sources.yaml