PostHog · Schema

HogFunctionInvocation

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
configuration object Full function configuration to test.
globals object Mock global variables available during test invocation.
clickhouse_event object Mock ClickHouse event data to test the function with.
mock_async_functions boolean When true (default), async functions like fetch() are simulated.
status string Invocation result status.
logs array Execution logs from the test invocation.
invocation_id string Optional invocation ID for correlation.
View JSON Schema on GitHub

JSON Schema

posthog-hogfunctioninvocation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HogFunctionInvocation",
  "title": "HogFunctionInvocation",
  "type": "object",
  "properties": {
    "configuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HogFunction"
        }
      ],
      "writeOnly": true,
      "description": "Full function configuration to test."
    },
    "globals": {
      "type": "object",
      "additionalProperties": true,
      "writeOnly": true,
      "description": "Mock global variables available during test invocation."
    },
    "clickhouse_event": {
      "type": "object",
      "additionalProperties": true,
      "writeOnly": true,
      "description": "Mock ClickHouse event data to test the function with."
    },
    "mock_async_functions": {
      "type": "boolean",
      "writeOnly": true,
      "default": true,
      "description": "When true (default), async functions like fetch() are simulated."
    },
    "status": {
      "type": "string",
      "readOnly": true,
      "description": "Invocation result status."
    },
    "logs": {
      "type": "array",
      "items": {},
      "readOnly": true,
      "description": "Execution logs from the test invocation."
    },
    "invocation_id": {
      "type": "string",
      "nullable": true,
      "description": "Optional invocation ID for correlation."
    }
  },
  "required": [
    "configuration",
    "logs",
    "status"
  ]
}