provider hog_functionshog_functions PUT /api/environments/{environment_id}/hog_functions/{id}/
@utdk/posthog /api/environments/{environment_id}/hog_functions/{id}/
environments_hog_functions_update
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this hog function.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsHogFunctionsUpdate
PUT/api/environments/{environment_id}/hog_functions/{id}/

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this hog function.

Input

required

Function type: destination, site_destination, internal_destination, source_webhook, warehouse_source_webhook, site_app, or transformation. * `destination` - Destination * `site_destination` - Site Destination * `internal_destination` - Internal Destination * `source_webhook` - Source Webhook * `warehouse_source_webhook` - Warehouse Source Webhook * `site_app` - Site App * `transformation` - Transformation

Display name for the function.

Human-readable description of what this function does.

required
required
required

Whether the function is active and processing events.

Soft-delete flag. Set to true to archive the function.

Source code. Hog language for most types; TypeScript for site_destination and site_app.

required
required

Schema defining the configurable input parameters for this function.

Values for each input defined in inputs_schema.

Event filters that control which events trigger this function.

PII masking configuration with TTL, threshold, and hash expression.

Event-to-destination field mappings. Only for destination and site_destination types.

URL for the function's icon displayed in the UI.

required

ID of the template to create this function from.

required

Execution priority for transformations. Lower values run first.

required
required

How this row matched the `search` query parameter: `exact` (the term is a case-insensitive substring of a searched field) or `similar` (a fuzzy trigram match, returned only when no exact match exists). Null when the list is not filtered by `search`.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsHogFunctionsUpdate()