PostHog · Schema

ExternalDataSourceSerializers

Mixin for serializers to add user access control fields

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
id	string
created_at	string
created_by	string
created_via	object	How this source was created. Defaults to `api` on create when omitted. `web` for the in-app UI, `api` for direct API callers, `mcp` for agent/MCP tool calls. Ignored on update. * `web` - web * `api` -
status	string
client_secret	string
account_id	string
source_type	object
latest_error	string
prefix	string
description	string
access_method	object
engine	object	Backend engine detected for the direct connection. * `duckdb` - duckdb * `postgres` - postgres
last_run_at	string
schemas	array
job_inputs	object
revenue_analytics_config	object
user_access_level	string	The effective access level the user has for this object
supports_webhooks	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ExternalDataSourceSerializers",
  "title": "ExternalDataSourceSerializers",
  "type": "object",
  "description": "Mixin for serializers to add user access control fields",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "created_by": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "created_via": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatedViaEnum"
        }
      ],
      "description": "How this source was created. Defaults to `api` on create when omitted. `web` for the in-app UI, `api` for direct API callers, `mcp` for agent/MCP tool calls. Ignored on update.\n\n* `web` - web\n* `api` - api\n* `mcp` - mcp"
    },
    "status": {
      "type": "string",
      "readOnly": true
    },
    "client_secret": {
      "type": "string",
      "writeOnly": true
    },
    "account_id": {
      "type": "string",
      "writeOnly": true
    },
    "source_type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExternalDataSourceTypeEnum"
        }
      ],
      "readOnly": true
    },
    "latest_error": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "prefix": {
      "type": "string",
      "nullable": true,
      "maxLength": 100
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 400
    },
    "access_method": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccessMethodEnum"
        }
      ],
      "readOnly": true
    },
    "engine": {
      "readOnly": true,
      "nullable": true,
      "description": "Backend engine detected for the direct connection.\n\n* `duckdb` - duckdb\n* `postgres` - postgres",
      "oneOf": [
        {
          "$ref": "#/components/schemas/EngineEnum"
        },
        {
          "$ref": "#/components/schemas/NullEnum"
        }
      ]
    },
    "last_run_at": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "schemas": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "readOnly": true
    },
    "job_inputs": {
      "nullable": true
    },
    "revenue_analytics_config": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExternalDataSourceRevenueAnalyticsConfig"
        }
      ],
      "readOnly": true
    },
    "user_access_level": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The effective access level the user has for this object"
    },
    "supports_webhooks": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "required": [
    "access_method",
    "account_id",
    "client_secret",
    "created_at",
    "created_by",
    "engine",
    "id",
    "last_run_at",
    "latest_error",
    "revenue_analytics_config",
    "schemas",
    "source_type",
    "status",
    "supports_webhooks",
    "user_access_level"
  ]
}