{ "opencollection": "1.0.0", "info": { "name": "PostHog actions external_data_sources API", "version": "1.0.0" }, "items": [ { "info": { "name": "external_data_sources", "type": "folder" }, "items": [ { "info": { "name": "environments_external_data_sources_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_bulk_update_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/bulk_update_schemas/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_create_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/create_webhook/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_delete_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/delete_webhook/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/jobs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_refresh_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/refresh_schemas/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync)." }, { "info": { "name": "environments_external_data_sources_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/reload/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_revenue_analytics_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/revenue_analytics_config/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the revenue analytics configuration and return the full external data source." }, { "info": { "name": "environments_external_data_sources_update_webhook_inputs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/update_webhook_inputs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_webhook_info_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/webhook_info/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_check_cdc_prerequisites_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/check_cdc_prerequisites/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate CDC prerequisites against a live Postgres connection.\n\nUsed by the source wizard to surface ✅/❌ checks before source creation,\nand by the self-managed setup popup to verify user-created publications." }, { "info": { "name": "environments_external_data_sources_connections_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/connections/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_database_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/database_schema/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_source_prefix_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/source_prefix/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_wizard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/wizard/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_bulk_update_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/bulk_update_schemas/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_create_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/create_webhook/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_delete_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/delete_webhook/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/jobs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_refresh_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/refresh_schemas/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync)." }, { "info": { "name": "external_data_sources_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/reload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_revenue_analytics_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/revenue_analytics_config/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the revenue analytics configuration and return the full external data source." }, { "info": { "name": "external_data_sources_update_webhook_inputs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/update_webhook_inputs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_webhook_info_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/webhook_info/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_check_cdc_prerequisites_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/check_cdc_prerequisites/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate CDC prerequisites against a live Postgres connection.\n\nUsed by the source wizard to surface ✅/❌ checks before source creation,\nand by the self-managed setup popup to verify user-created publications." }, { "info": { "name": "external_data_sources_connections_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/connections/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_database_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/database_schema/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_source_prefix_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/source_prefix/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_wizard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/wizard/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." } ] } ], "bundled": true }