Resource HogFunction in pulumi-posthog.
Pulumi type: posthog:index/hogFunction:HogFunction.
name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.
Example#
Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.
Arguments#
| Property | Type | Required | Description |
|---|---|---|---|
description | string | no | Description of the Hog function. |
enabled | boolean | no | Whether the Hog function is enabled. Defaults to true. |
executionOrder | number | no | Order in which this Hog function executes relative to others (0-32767). |
filtersJson | string | no | JSON object defining filters for when the Hog function should execute. Includes events, actions, properties, and filterTestAccounts options. |
hog | string | no | The Hog code to execute. Not required when using a template - the template provides the code. |
iconUrl | string | no | URL of the icon for this Hog function. |
inputsJson | string | no | JSON object containing the input values for the Hog function. Keys correspond to the input schema, values contain value and optional templating properties. For inputs containing secrets, use sensitiveInputsJson instead. |
inputsSchemaJson | string | no | JSON array defining custom input schema entries for the Hog function. Each entry is an object with key, type, secret, required, and other properties. Sent directly as inputsSchema in the API request. When using a template, this replaces the template's default schema. |
mappingsJson | string | no | JSON array of mapping configurations. Each mapping can have its own name, inputsSchema, inputs, and filters. |
maskingJson | string | no | JSON object configuring PII masking for the Hog function. Includes ttl, threshold, and hash properties. |
name | string | no | Name of the Hog function. |
projectId | string | no | Project ID (environment) for this resource. Overrides the provider-level project_id. |
sensitiveInputsJson | string | no | JSON object containing sensitive input values (e.g. API keys, tokens, credentials) for the Hog function. Same format as inputsJson. Values are merged with inputsJson at apply time and redacted from plan/apply output. If the same key appears in both, sensitiveInputsJson takes precedence. |
templateId | string | no | ID of a template to use as the basis for this Hog function. The template provides default code, inputs schema, and configuration. |
type | string | no | Type of Hog function: destination, siteDestination, internalDestination, sourceWebhook, siteApp, or transformation. |
Outputs#
Computed outputs are produced by the provider. They are not constructor arguments.
| Property | Type | Computed | Description |
|---|---|---|---|
description | string | no | Description of the Hog function. |
enabled | boolean | no | Whether the Hog function is enabled. Defaults to true. |
executionOrder | number | no | Order in which this Hog function executes relative to others (0-32767). |
filtersJson | string | no | JSON object defining filters for when the Hog function should execute. Includes events, actions, properties, and filterTestAccounts options. |
hog | string | no | The Hog code to execute. Not required when using a template - the template provides the code. |
iconUrl | string | no | URL of the icon for this Hog function. |
inputsJson | string | no | JSON object containing the input values for the Hog function. Keys correspond to the input schema, values contain value and optional templating properties. For inputs containing secrets, use sensitiveInputsJson instead. |
inputsSchemaJson | string | no | JSON array defining custom input schema entries for the Hog function. Each entry is an object with key, type, secret, required, and other properties. Sent directly as inputsSchema in the API request. When using a template, this replaces the template's default schema. |
mappingsJson | string | no | JSON array of mapping configurations. Each mapping can have its own name, inputsSchema, inputs, and filters. |
maskingJson | string | no | JSON object configuring PII masking for the Hog function. Includes ttl, threshold, and hash properties. |
name | string | no | Name of the Hog function. |
projectId | string | no | Project ID (environment) for this resource. Overrides the provider-level project_id. |
sensitiveInputsJson | string | no | JSON object containing sensitive input values (e.g. API keys, tokens, credentials) for the Hog function. Same format as inputsJson. Values are merged with inputsJson at apply time and redacted from plan/apply output. If the same key appears in both, sensitiveInputsJson takes precedence. |
templateId | string | no | ID of a template to use as the basis for this Hog function. The template provides default code, inputs schema, and configuration. |
type | string | no | Type of Hog function: destination, siteDestination, internalDestination, sourceWebhook, siteApp, or transformation. |