PostHog · Schema

HogFunctionMappingTemplate

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
name string Name of this mapping template.
include_by_default boolean Whether this mapping is enabled by default.
use_all_events_by_default boolean Whether this mapping should match all events by default, hiding the event filter UI.
filters object Event filters specific to this mapping.
inputs object Input values specific to this mapping.
inputs_schema object Additional input schema fields specific to this mapping.
View JSON Schema on GitHub

JSON Schema

posthog-hogfunctionmappingtemplate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HogFunctionMappingTemplate",
  "title": "HogFunctionMappingTemplate",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of this mapping template."
    },
    "include_by_default": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this mapping is enabled by default."
    },
    "use_all_events_by_default": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this mapping should match all events by default, hiding the event filter UI."
    },
    "filters": {
      "nullable": true,
      "description": "Event filters specific to this mapping."
    },
    "inputs": {
      "nullable": true,
      "description": "Input values specific to this mapping."
    },
    "inputs_schema": {
      "nullable": true,
      "description": "Additional input schema fields specific to this mapping."
    }
  },
  "required": [
    "name"
  ]
}