Hog functions API Reference

Hog functions

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`DELETE`
`POST`
`POST`
`GET`
`GET`
`GET`
`POST`
`GET`
`GET`
`PATCH`

← Previous page

Delete hog functions

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Delete hog functions

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create hog functions enable backfills

Path parameters

id
string

Request parameters

type
name
stringnull
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
arraynull
icon_url
stringnull
template_id
stringnull
execution_order
integernull
_create_in_folder
string

Example request

POST /api/projects/:project_id/hog_functions/:id/enable_backfills
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/enable_backfills/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/enable_backfills/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Create hog functions enable backfills

Path parameters

id
string

Request parameters

type
name
stringnull
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
arraynull
icon_url
stringnull
template_id
stringnull
execution_order
integernull
_create_in_folder
string

Example request

POST /api/projects/:project_id/hog_functions/:id/enable_backfills
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/enable_backfills/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/enable_backfills/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Create hog functions invocations

Required API key scopes

hog_function:write

Path parameters

id
string

Request parameters

configuration
globals
object
clickhouse_event
object
mock_async_functions
boolean
Default: true
invocation_id
stringnull

Response

Example request

POST /api/projects/:project_id/hog_functions/:id/invocations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/invocations/\
	-d configuration=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/invocations/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "destination",
    "name": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "updated_at": "2019-08-24T14:15:22Z",
    "enabled": true,
    "deleted": true,
    "hog": "string",
    "bytecode": null,
    "transpiled": "string",
    "inputs_schema": [
      {
        "type": "string",
        "key": "string",
        "label": "string",
        "choices": [
          {}
        ],
        "searchable": true,
        "required": false,
        "default": null,
        "secret": false,
        "hidden": false,
        "description": "string",
        "integration": "string",
        "integration_key": "string",
        "requires_field": "string",
        "integration_field": "string",
        "requiredScopes": "string",
        "templating": true
      }
    ],
    "inputs": {
      "property1": {
        "value": null,
        "templating": "hog",
        "bytecode": [
          null
        ],
        "order": 0,
        "transpiled": null
      },
      "property2": {
        "value": null,
        "templating": "hog",
        "bytecode": [
          null
        ],
        "order": 0,
        "transpiled": null
      }
    },
    "filters": {
      "source": "events",
      "actions": [
        {}
      ],
      "events": [
        {}
      ],
      "data_warehouse": [
        {}
      ],
      "properties": [
        {}
      ],
      "bytecode": null,
      "transpiled": null,
      "filter_test_accounts": true,
      "bytecode_error": "string"
    },
    "masking": {
      "ttl": 60,
      "threshold": 0,
      "hash": "string",
      "bytecode": null
    },
    "mappings": [
      {
        "name": "string",
        "inputs_schema": [
          {
            "type": "string",
            "key": "string",
            "label": "string",
            "choices": [
              {}
            ],
            "searchable": true,
            "required": false,
            "default": null,
            "secret": false,
            "hidden": false,
            "description": "string",
            "integration": "string",
            "integration_key": "string",
            "requires_field": "string",
            "integration_field": "string",
            "requiredScopes": "string",
            "templating": true
          }
        ],
        "inputs": {
          "property1": {
            "value": null,
            "templating": "hog",
            "bytecode": [
              null
            ],
            "order": 0,
            "transpiled": null
          },
          "property2": {
            "value": null,
            "templating": "hog",
            "bytecode": [
              null
            ],
            "order": 0,
            "transpiled": null
          }
        },
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "icon_url": "string",
    "template": {
      "id": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "code_language": "string",
      "inputs_schema": null,
      "type": "string",
      "status": "string",
      "category": null,
      "free": true,
      "icon_url": "string",
      "filters": null,
      "masking": null,
      "mapping_templates": [
        {
          "name": "string",
          "include_by_default": true,
          "use_all_events_by_default": true,
          "filters": null,
          "inputs": null,
          "inputs_schema": null
        }
      ]
    },
    "template_id": "string",
    "status": {
      "state": 0,
      "tokens": 0
    },
    "execution_order": 32767,
    "_create_in_folder": "string",
    "batch_export_id": "b64664c0-dba6-4c8b-9083-fa5e13aac47d",
    "search_match_type": "exact"
  },
  "globals": {},
  "clickhouse_event": {},
  "mock_async_functions": true,
  "status": "string",
  "logs": [
    null
  ],
  "invocation_id": "string"
}

Create hog functions invocations

Required API key scopes

hog_function:write

Path parameters

id
string

Request parameters

configuration
globals
object
clickhouse_event
object
mock_async_functions
boolean
Default: true
invocation_id
stringnull

Response

Example request

POST /api/projects/:project_id/hog_functions/:id/invocations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/invocations/\
	-d configuration=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/invocations/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "destination",
    "name": "string",
    "description": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "updated_at": "2019-08-24T14:15:22Z",
    "enabled": true,
    "deleted": true,
    "hog": "string",
    "bytecode": null,
    "transpiled": "string",
    "inputs_schema": [
      {
        "type": "string",
        "key": "string",
        "label": "string",
        "choices": [
          {}
        ],
        "searchable": true,
        "required": false,
        "default": null,
        "secret": false,
        "hidden": false,
        "description": "string",
        "integration": "string",
        "integration_key": "string",
        "requires_field": "string",
        "integration_field": "string",
        "requiredScopes": "string",
        "templating": true
      }
    ],
    "inputs": {
      "property1": {
        "value": null,
        "templating": "hog",
        "bytecode": [
          null
        ],
        "order": 0,
        "transpiled": null
      },
      "property2": {
        "value": null,
        "templating": "hog",
        "bytecode": [
          null
        ],
        "order": 0,
        "transpiled": null
      }
    },
    "filters": {
      "source": "events",
      "actions": [
        {}
      ],
      "events": [
        {}
      ],
      "data_warehouse": [
        {}
      ],
      "properties": [
        {}
      ],
      "bytecode": null,
      "transpiled": null,
      "filter_test_accounts": true,
      "bytecode_error": "string"
    },
    "masking": {
      "ttl": 60,
      "threshold": 0,
      "hash": "string",
      "bytecode": null
    },
    "mappings": [
      {
        "name": "string",
        "inputs_schema": [
          {
            "type": "string",
            "key": "string",
            "label": "string",
            "choices": [
              {}
            ],
            "searchable": true,
            "required": false,
            "default": null,
            "secret": false,
            "hidden": false,
            "description": "string",
            "integration": "string",
            "integration_key": "string",
            "requires_field": "string",
            "integration_field": "string",
            "requiredScopes": "string",
            "templating": true
          }
        ],
        "inputs": {
          "property1": {
            "value": null,
            "templating": "hog",
            "bytecode": [
              null
            ],
            "order": 0,
            "transpiled": null
          },
          "property2": {
            "value": null,
            "templating": "hog",
            "bytecode": [
              null
            ],
            "order": 0,
            "transpiled": null
          }
        },
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "icon_url": "string",
    "template": {
      "id": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "code_language": "string",
      "inputs_schema": null,
      "type": "string",
      "status": "string",
      "category": null,
      "free": true,
      "icon_url": "string",
      "filters": null,
      "masking": null,
      "mapping_templates": [
        {
          "name": "string",
          "include_by_default": true,
          "use_all_events_by_default": true,
          "filters": null,
          "inputs": null,
          "inputs_schema": null
        }
      ]
    },
    "template_id": "string",
    "status": {
      "state": 0,
      "tokens": 0
    },
    "execution_order": 32767,
    "_create_in_folder": "string",
    "batch_export_id": "b64664c0-dba6-4c8b-9083-fa5e13aac47d",
    "search_match_type": "exact"
  },
  "globals": {},
  "clickhouse_event": {},
  "mock_async_functions": true,
  "status": "string",
  "logs": [
    null
  ],
  "invocation_id": "string"
}

Retrieve hog functions logs

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
before
string
instance_id
string
level
string
limit
integer
Default: 50
search
string

Example request

GET /api/projects/:project_id/hog_functions/:id/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/logs/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions logs

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
before
string
instance_id
string
level
string
limit
integer
Default: 50
search
string

Example request

GET /api/projects/:project_id/hog_functions/:id/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/logs/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions metrics

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

GET /api/projects/:project_id/hog_functions/:id/metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/metrics/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/metrics/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "labels": [
    "string"
  ],
  "series": [
    {
      "name": "string",
      "values": [
        0
      ]
    }
  ]
}

Retrieve hog functions metrics

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

GET /api/projects/:project_id/hog_functions/:id/metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/metrics/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/metrics/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "labels": [
    "string"
  ],
  "series": [
    {
      "name": "string",
      "values": [
        0
      ]
    }
  ]
}

Retrieve hog functions metrics totals

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

GET /api/projects/:project_id/hog_functions/:id/metrics/totals
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/metrics/totals/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/metrics/totals/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "totals": {
    "property1": 0,
    "property2": 0
  }
}

Retrieve hog functions metrics totals

Required API key scopes

hog_function:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

GET /api/projects/:project_id/hog_functions/:id/metrics/totals
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/metrics/totals/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/metrics/totals/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "totals": {
    "property1": 0,
    "property2": 0
  }
}

Create hog functions rerun

Rerun past invocations of this hog function from their stored payloads.

The CDP worker reads matching rows from the hog_invocation_results ClickHouse table, rehydrates the invocation from the stored invocation_globals, and re-enqueues onto cyclotron. Each rerun run reuses the original invocation_id with is_retry=1 set on the new lifecycle row so the UI can surface that it was a rerun.

For source-webhook functions the worker strips request.headers from the rehydrated globals before re-enqueuing (see the rerun paginator): those headers carry the inbound sender's credentials, and replaying them through a reconfigured function would let a write-access user exfiltrate stored secrets.

Because rerun replays historical event/person/group data, it requires person:read and group:read on top of hog_function:write.

Required API key scopes

hog_function:writeperson:readgroup:read

Path parameters

id
string

Request parameters

filter

Response

Example request

POST /api/projects/:project_id/hog_functions/:id/rerun
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/rerun/\
	-d filter=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/rerun/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}

Status 400

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}

Create hog functions rerun

Rerun past invocations of this hog function from their stored payloads.

Because rerun replays historical event/person/group data, it requires person:read and group:read on top of hog_function:write.

Required API key scopes

hog_function:writeperson:readgroup:read

Path parameters

id
string

Request parameters

filter

Response

Example request

POST /api/projects/:project_id/hog_functions/:id/rerun
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/:id/rerun/\
	-d filter=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/{hog_functions-3_id}/rerun/".format(
        project_id=project_id,
		hog_functions-3_id="<the hog functions-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}

Status 400

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}

Retrieve hog functions icon

Example request

GET /api/projects/:project_id/hog_functions/icon
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/icon/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/icon/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions icon

Example request

GET /api/projects/:project_id/hog_functions/icon
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/icon/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/icon/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions icons

Example request

GET /api/projects/:project_id/hog_functions/icons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/icons/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/icons/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions icons

Example request

GET /api/projects/:project_id/hog_functions/icons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/icons/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/icons/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update hog functions rearrange

Update the execution order of multiple HogFunctions.

Required API key scopes

hog_function:write

Request parameters

orders
object

Example request

PATCH /api/projects/:project_id/hog_functions/rearrange
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/rearrange/\
	-d orders="object"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/rearrange/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"orders": "object"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "destination",
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "deleted": true,
  "hog": "string",
  "bytecode": null,
  "transpiled": "string",
  "inputs_schema": [
    {
      "type": "string",
      "key": "string",
      "label": "string",
      "choices": [
        {}
      ],
      "searchable": true,
      "required": false,
      "default": null,
      "secret": false,
      "hidden": false,
      "description": "string",
      "integration": "string",
      "integration_key": "string",
      "requires_field": "string",
      "integration_field": "string",
      "requiredScopes": "string",
      "templating": true
    }
  ],
  "inputs": {
    "property1": {
      "value": null,
      "templating": "hog",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": null,
      "templating": "hog",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "source": "events",
    "actions": [
      {}
    ],
    "events": [
      {}
    ],
    "data_warehouse": [
      {}
    ],
    "properties": [
      {}
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "name": "string",
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {}
          ],
          "searchable": true,
          "required": false,
          "default": null,
          "secret": false,
          "hidden": false,
          "description": "string",
          "integration": "string",
          "integration_key": "string",
          "requires_field": "string",
          "integration_field": "string",
          "requiredScopes": "string",
          "templating": true
        }
      ],
      "inputs": {
        "property1": {
          "value": null,
          "templating": "hog",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": null,
          "templating": "hog",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "id": "string",
    "name": "string",
    "description": "string",
    "code": "string",
    "code_language": "string",
    "inputs_schema": null,
    "type": "string",
    "status": "string",
    "category": null,
    "free": true,
    "icon_url": "string",
    "filters": null,
    "masking": null,
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "use_all_events_by_default": true,
        "filters": null,
        "inputs": null,
        "inputs_schema": null
      }
    ]
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string",
  "batch_export_id": "b64664c0-dba6-4c8b-9083-fa5e13aac47d",
  "search_match_type": "exact"
}

Update hog functions rearrange

Update the execution order of multiple HogFunctions.

Required API key scopes

hog_function:write

Request parameters

orders
object

Example request

PATCH /api/projects/:project_id/hog_functions/rearrange
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_functions/rearrange/\
	-d orders="object"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/hog_functions/rearrange/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"orders": "object"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "destination",
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "deleted": true,
  "hog": "string",
  "bytecode": null,
  "transpiled": "string",
  "inputs_schema": [
    {
      "type": "string",
      "key": "string",
      "label": "string",
      "choices": [
        {}
      ],
      "searchable": true,
      "required": false,
      "default": null,
      "secret": false,
      "hidden": false,
      "description": "string",
      "integration": "string",
      "integration_key": "string",
      "requires_field": "string",
      "integration_field": "string",
      "requiredScopes": "string",
      "templating": true
    }
  ],
  "inputs": {
    "property1": {
      "value": null,
      "templating": "hog",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": null,
      "templating": "hog",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "source": "events",
    "actions": [
      {}
    ],
    "events": [
      {}
    ],
    "data_warehouse": [
      {}
    ],
    "properties": [
      {}
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "name": "string",
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {}
          ],
          "searchable": true,
          "required": false,
          "default": null,
          "secret": false,
          "hidden": false,
          "description": "string",
          "integration": "string",
          "integration_key": "string",
          "requires_field": "string",
          "integration_field": "string",
          "requiredScopes": "string",
          "templating": true
        }
      ],
      "inputs": {
        "property1": {
          "value": null,
          "templating": "hog",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": null,
          "templating": "hog",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "id": "string",
    "name": "string",
    "description": "string",
    "code": "string",
    "code_language": "string",
    "inputs_schema": null,
    "type": "string",
    "status": "string",
    "category": null,
    "free": true,
    "icon_url": "string",
    "filters": null,
    "masking": null,
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "use_all_events_by_default": true,
        "filters": null,
        "inputs": null,
        "inputs_schema": null
      }
    ]
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string",
  "batch_export_id": "b64664c0-dba6-4c8b-9083-fa5e13aac47d",
  "search_match_type": "exact"
}

← Previous page