Environments-10 API Reference

Environments-10

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

Endpoints

`POST`	`/api/environments/:project_id/hog_functions/`
`GET`	`/api/environments/:project_id/hog_functions/:id/`
`PATCH`	`/api/environments/:project_id/hog_functions/:id/`
`DELETE`	`/api/environments/:project_id/hog_functions/:id/`
`POST`	`/api/environments/:project_id/hog_functions/:id/broadcast/`
`POST`	`/api/environments/:project_id/hog_functions/:id/invocations/`
`GET`	`/api/environments/:project_id/hog_functions/:id/logs/`
`GET`	`/api/environments/:project_id/hog_functions/:id/metrics/`
`GET`	`/api/environments/:project_id/hog_functions/:id/metrics/totals/`

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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",
  "kind": "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,
  "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": [
    {
      "name": "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"
      }
    }
  ],
  "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": [
      {
        "name": "string",
        "filters": {
          "property1": null,
          "property2": null
        },
        "inputs": {
          "property1": null,
          "property2": null
        },
        "inputs_schema": [
          {
            "property1": null,
            "property2": null
          }
        ]
      }
    ],
    "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",
    "kind": "messaging_campaign"
  },
  "template_id": "string",
  "status": {
    "state": 0,
    "rating": 0.1,
    "tokens": 0
  },
  "execution_order": 32767,
  "_create_in_folder": "string"
}

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 broadcast

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

Request

POST /api/environments/:project_id/hog_functions/:id/broadcast

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/broadcast/\
	-d type=undefined

Response

Status 200 No response body

Create environments hog functions broadcast

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

Request

POST /api/environments/:project_id/hog_functions/:id/broadcast

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/broadcast/\
	-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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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
kind
string
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

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

Retrieve environments hog functions logs

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

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

Response

Status 200 No response body

Retrieve environments hog functions logs

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

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

Response

Status 200 No response body

Retrieve environments hog functions metrics

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

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

Response

Status 200 No response body

Retrieve environments hog functions metrics

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

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

Response

Status 200 No response body

Retrieve environments hog functions metrics totals

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

GET /api/environments/: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/environments/:project_id/hog_functions/:id/metrics/totals/

Response

Status 200 No response body

Retrieve environments hog functions metrics totals

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

GET /api/environments/: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/environments/:project_id/hog_functions/:id/metrics/totals/