Environments-6

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

Retrieve environments groups property definitions

Path parameters

  • project_id
    string

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

Request

GET /api/environments/:project_id/groups/property_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/property_definitions/

Response

Status 200 No response body

Retrieve environments groups property definitions

Path parameters

  • project_id
    string

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

Request

GET /api/environments/:project_id/groups/property_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/property_definitions/

Response

Status 200 No response body

Retrieve environments groups property values

Path parameters

  • project_id
    string

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

Request

GET /api/environments/:project_id/groups/property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/property_values/

Response

Status 200 No response body

Retrieve environments groups property values

Path parameters

  • project_id
    string

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

Request

GET /api/environments/:project_id/groups/property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/groups/property_values/

Response

Status 200 No response body

List all environments hog functions

Required API key scopes

hog_function:read

Path parameters

  • project_id
    string

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

Query parameters

  • created_at
    string
  • created_by
    integer
  • enabled
    boolean
  • id
    string
  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • type
    array

    Multiple values may be separated by commas.

  • updated_at
    string

Response


Request

GET /api/environments/:project_id/hog_functions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/

Response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "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": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "enabled": true,
      "hog": "string",
      "filters": null,
      "icon_url": "string",
      "template": "string",
      "status": {
        "state": 0,
        "rating": 0.1,
        "tokens": 0
      },
      "execution_order": 0
    }
  ]
}

List all environments hog functions

Required API key scopes

hog_function:read

Path parameters

  • project_id
    string

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

Query parameters

  • created_at
    string
  • created_by
    integer
  • enabled
    boolean
  • id
    string
  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • type
    array

    Multiple values may be separated by commas.

  • updated_at
    string

Response


Request

GET /api/environments/:project_id/hog_functions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/

Response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "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": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "enabled": true,
      "hog": "string",
      "filters": null,
      "icon_url": "string",
      "template": "string",
      "status": {
        "state": 0,
        "rating": 0.1,
        "tokens": 0
      },
      "execution_order": 0
    }
  ]
}

Create environments hog functions

Required API key scopes

hog_function:write

Path parameters

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Response


Request

POST /api/environments/:project_id/hog_functions
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/environments/:project_id/hog_functions/\
	-d type=undefined

Response

Status 201
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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Create environments hog functions

Required API key scopes

hog_function:write

Path parameters

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Response


Request

POST /api/environments/:project_id/hog_functions
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/environments/:project_id/hog_functions/\
	-d type=undefined

Response

Status 201
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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Retrieve environments hog functions

Required API key scopes

hog_function:read

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Response


Request

GET /api/environments/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/:id/

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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Retrieve environments hog functions

Required API key scopes

hog_function:read

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Response


Request

GET /api/environments/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/:id/

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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Update environments hog functions

Required API key scopes

hog_function:write

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Response


Request

PATCH /api/environments/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/:id/\
	-d type=undefined

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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Update environments hog functions

Required API key scopes

hog_function:write

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Response


Request

PATCH /api/environments/:project_id/hog_functions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/hog_functions/:id/\
	-d type=undefined

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": {
      "property1": null,
      "property2": null
    },
    "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": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "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": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    },
    "property2": {
      "value": "string",
      "bytecode": [
        null
      ],
      "order": 0,
      "transpiled": null
    }
  },
  "filters": {
    "actions": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "events": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "properties": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "bytecode": null,
    "transpiled": null,
    "filter_test_accounts": true,
    "bytecode_error": "string"
  },
  "masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "mappings": [
    {
      "inputs_schema": [
        {
          "type": "string",
          "key": "string",
          "label": "string",
          "choices": [
            {
              "property1": null,
              "property2": null
            }
          ],
          "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": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        },
        "property2": {
          "value": "string",
          "bytecode": [
            null
          ],
          "order": 0,
          "transpiled": null
        }
      },
      "filters": {
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      }
    }
  ],
  "icon_url": "string",
  "template": {
    "mapping_templates": [
      {
        "name": "string",
        "include_by_default": true,
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "mappings": [
      {
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "sub_templates": [
      {
        "id": "early-access-feature-enrollment",
        "name": "string",
        "description": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "masking": {
          "property1": null,
          "property2": null
        },
        "input_schema_overrides": {
          "property1": {
            "property1": null,
            "property2": null
          },
          "property2": {
            "property1": null,
            "property2": null
          }
        },
        "type": "destination"
      }
    ],
    "status": "alpha",
    "free": true,
    "type": "destination",
    "id": "string",
    "name": "string",
    "hog": "string",
    "inputs_schema": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "category": [
      "string"
    ],
    "description": "string",
    "filters": {
      "property1": null,
      "property2": null
    },
    "masking": {
      "property1": null,
      "property2": null
    },
    "icon_url": "string"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767
}

Delete environments hog functions

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

Required API key scopes

hog_function:write

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request

DELETE /api/environments/: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/environments/:project_id/hog_functions/:id/

Response

Status 405 No response body

Delete environments hog functions

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

Required API key scopes

hog_function:write

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request

DELETE /api/environments/: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/environments/:project_id/hog_functions/:id/

Response

Status 405 No response body

Create environments hog functions invocations

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Request

POST /api/environments/: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/environments/:project_id/hog_functions/:id/invocations/\
	-d type=undefined

Response

Status 200 No response body

Create environments hog functions invocations

Path parameters

  • id
    string

    A UUID string identifying this hog function.

  • project_id
    string

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

Request parameters

  • type
  • name
    string
  • description
    string
  • enabled
    boolean
  • deleted
    boolean
  • hog
    string
  • inputs_schema
    Click to open
    array
  • inputs
    object
  • filters
  • masking
  • mappings
    Click to open
    array
  • icon_url
    string
  • template_id
    string
  • execution_order
    integer

Request

POST /api/environments/: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/environments/:project_id/hog_functions/:id/invocations/\
	-d type=undefined

Response

Status 200 No response body
Next page →

Community questions

Was this page useful?