hog_functions
hog_functions

post/api/projects/{project_id}/hog_functions/{id}/invocations/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_functions/{id}/invocations/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog function.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

use_draftboolean

Test the function's staged draft instead of passing a configuration. Staged secret inputs are used; secrets the draft doesn't change fall back to the live values. 400 when nothing is staged.

globalsobject

Mock global variables available during test invocation.

clickhouse_eventobject

Mock ClickHouse event data to test the function with.

mock_async_functionsboolean

When true (default), async functions like fetch() are simulated.

statusstring required

Invocation result status.

invocation_idstring nullable

Optional invocation ID for correlation.

Response

use_draftboolean

Test the function's staged draft instead of passing a configuration. Staged secret inputs are used; secrets the draft doesn't change fall back to the live values. 400 when nothing is staged.

globalsobject

Mock global variables available during test invocation.

clickhouse_eventobject

Mock ClickHouse event data to test the function with.

mock_async_functionsboolean

When true (default), async functions like fetch() are simulated.

statusstring required

Invocation result status.

invocation_idstring nullable

Optional invocation ID for correlation.

Changes

No recorded changes to this operation across all 1 revision of this API.