How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog hog_functions API

The hog_functions API from PostHog — 20 operation(s) for hog_functions.

PostHog hog_functions API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 28 operations across 20 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

28 operations 20 paths 26 schemas 2 DELETE14 GET4 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog hog_functions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 28

Across 20 paths, the API surfaces 28 operations — 2 DELETE, 14 GET, 4 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

hog_functions 28
GET
/api/environments/{environment_id}/hog_functions/deprecated
environments_hog_functions_list 10 params → 200
POST
/api/environments/{environment_id}/hog_functions/deprecated
environments_hog_functions_create 1 param body → 201
GET
/api/environments/{environment_id}/hog_functions/{id}/deprecated
environments_hog_functions_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/hog_functions/{id}/deprecated
environments_hog_functions_update 2 params body → 200
PATCH
/api/environments/{environment_id}/hog_functions/{id}/deprecated
environments_hog_functions_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/hog_functions/{id}/deprecated
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
environments_hog_functions_destroy 2 params → 405
POST
/api/environments/{environment_id}/hog_functions/{id}/enable_backfills/deprecated
environments_hog_functions_enable_backfills_create 2 params body → 200
POST
/api/environments/{environment_id}/hog_functions/{id}/invocations/deprecated
environments_hog_functions_invocations_create 2 params body → 200
GET
/api/environments/{environment_id}/hog_functions/{id}/logs/deprecated
environments_hog_functions_logs_retrieve 8 params → 200
GET
/api/environments/{environment_id}/hog_functions/{id}/metrics/deprecated
environments_hog_functions_metrics_retrieve 9 params → 200
GET
/api/environments/{environment_id}/hog_functions/{id}/metrics/totals/deprecated
environments_hog_functions_metrics_totals_retrieve 9 params → 200
GET
/api/environments/{environment_id}/hog_functions/icon/deprecated
environments_hog_functions_icon_retrieve 1 param → 200
GET
/api/environments/{environment_id}/hog_functions/icons/deprecated
environments_hog_functions_icons_retrieve 1 param → 200
PATCH
/api/environments/{environment_id}/hog_functions/rearrange/deprecated
Update the execution order of multiple HogFunctions.
environments_hog_functions_rearrange_partial_update 1 param body → 200
GET
/api/projects/{project_id}/hog_functions/
hog_functions_list 10 params → 200
POST
/api/projects/{project_id}/hog_functions/
hog_functions_create 1 param body → 201
GET
/api/projects/{project_id}/hog_functions/{id}/
hog_functions_retrieve 2 params → 200
PUT
/api/projects/{project_id}/hog_functions/{id}/
hog_functions_update 2 params body → 200
PATCH
/api/projects/{project_id}/hog_functions/{id}/
hog_functions_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/hog_functions/{id}/
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
hog_functions_destroy 2 params → 405
POST
/api/projects/{project_id}/hog_functions/{id}/enable_backfills/
hog_functions_enable_backfills_create 2 params body → 200
POST
/api/projects/{project_id}/hog_functions/{id}/invocations/
hog_functions_invocations_create 2 params body → 200
GET
/api/projects/{project_id}/hog_functions/{id}/logs/
hog_functions_logs_retrieve 8 params → 200
GET
/api/projects/{project_id}/hog_functions/{id}/metrics/
hog_functions_metrics_retrieve 9 params → 200
GET
/api/projects/{project_id}/hog_functions/{id}/metrics/totals/
hog_functions_metrics_totals_retrieve 9 params → 200
GET
/api/projects/{project_id}/hog_functions/icon/
hog_functions_icon_retrieve 1 param → 200
GET
/api/projects/{project_id}/hog_functions/icons/
hog_functions_icons_retrieve 1 param → 200
PATCH
/api/projects/{project_id}/hog_functions/rearrange/
Update the execution order of multiple HogFunctions.
hog_functions_rearrange_partial_update 1 param body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are HogFunction (24 properties), PatchedHogFunction (24 properties), InputsSchemaItem (15 properties), HogFunctionMinimal (14 properties). Each schema is shown below with its type and property counts.

HogFunctionInvocation
object
7 properties 3 required
Mappings
object
4 properties
AppMetricSeries
object
2 properties 2 required
HogFunctionStatusStateEnum
integer
0 - 0 1 - 1 2 - 2 3 - 3 11 - 11 12 - 12
NullEnum
HogFunctionMasking
object
4 properties 2 required
PatchedHogFunction
object
24 properties
InputsSchemaItem
object
15 properties 2 required
HogFunctionFiltersSourceEnum
string
events - events person-updates - person-updates data-warehouse-table - data-warehouse-table
InputsItem
object
5 properties 3 required
AppMetricsResponse
object
2 properties 2 required
HogFunction
object
24 properties 9 required
HogFunctionStatus
object
2 properties 2 required
HogFunctionTypeEnum
string
destination - Destination sitedestination - Site Destination internaldestination - Internal Destination sourcewebhook - Source Webhook warehousesourcewebhook -…
HogFunctionFilters
object
9 properties
InputsSchemaItemTypeEnum
string
string - string number - number boolean - boolean dictionary - dictionary choice - choice json - json integration - integration integrationfield - integrationf…
AppMetricsTotalsResponse
object
1 property 1 required
HogFunctionMappingTemplate
object
6 properties 1 required
HogFunctionTemplatingEnum
string
hog - hog liquid - liquid
PaginatedHogFunctionMinimalList
object
4 properties 2 required
UserBasic
object
9 properties 4 required
BlankEnum
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
HogFunctionMinimal
object
14 properties 14 required
HogFunctionTemplate
object
14 properties 5 required
PatchedHogFunctionRearrange
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-hog-functions-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog hog_functions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.