Event definitions

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

Endpoints

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

List all event definitions

List the event definitions of a project. On projects with more than 50000 event definitions, count stops at 10000 and count_is_capped is true, unless the request sets search, exclude_stale, verified, names, tags or event_type=event_posthog. Projects with more than 100000 event definitions also default to ordering by name under the same condition.

Required API key scopes

event_definition:read

Query parameters

  • event_type
    string
    One of: "event""event_custom""event_posthog"
  • exclude_hidden
    boolean
  • exclude_stale
    boolean
  • excluded_properties
    string
  • fuzzy_search
    boolean
  • limit
    integer
    Default: 100
  • names
    array
  • offset
    integer
    Default: 0
  • ordering
    array
  • search
    string
  • tags
    string
  • verified
    boolean

Response


Example request

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

Example 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",
      "name": "string",
      "owner": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "description": "string",
      "tags": [
        null
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "updated_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "last_seen_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "verified": true,
      "verified_at": "2019-08-24T14:15:22Z",
      "verified_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "hidden": true,
      "scheduled_deletion_at": "2019-08-24T14:15:22Z",
      "enforcement_mode": "allow",
      "primary_property": "string",
      "is_action": true,
      "action_id": 0,
      "is_calculating": true,
      "last_calculated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "post_to_slack": false,
      "default_columns": [
        "string"
      ],
      "media_preview_urls": [
        "string"
      ]
    }
  ],
  "count_is_capped": true
}

Create event definitions

Required API key scopes

event_definition:write

Request parameters

  • name
    string
  • owner
    integer | null
  • description
    string | null
  • tags
    array
  • verified
    boolean
  • hidden
    boolean | null
  • enforcement_mode
  • primary_property
    string | null
  • post_to_slack
    boolean
    Default: false
  • default_columns
    array

Response


Example request

POST /api/projects/:project_id/event_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "owner": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "description": "string",
  "tags": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verified_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "hidden": true,
  "scheduled_deletion_at": "2019-08-24T14:15:22Z",
  "enforcement_mode": "allow",
  "primary_property": "string",
  "is_action": true,
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "post_to_slack": false,
  "default_columns": [
    "string"
  ],
  "media_preview_urls": [
    "string"
  ]
}

Retrieve event definitions

Required API key scopes

event_definition:read

Path parameters

  • id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "owner": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "description": "string",
  "tags": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verified_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "hidden": true,
  "scheduled_deletion_at": "2019-08-24T14:15:22Z",
  "enforcement_mode": "allow",
  "primary_property": "string",
  "is_action": true,
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "post_to_slack": false,
  "default_columns": [
    "string"
  ],
  "media_preview_urls": [
    "string"
  ]
}

Update event definitions

Required API key scopes

event_definition:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • owner
    integer | null
  • description
    string | null
  • tags
    array
  • verified
    boolean
  • hidden
    boolean | null
  • enforcement_mode
  • primary_property
    string | null
  • post_to_slack
    boolean
    Default: false
  • default_columns
    array

Response


Example request

PATCH /api/projects/:project_id/event_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "owner": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "description": "string",
  "tags": [
    null
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "updated_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verified_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "hidden": true,
  "scheduled_deletion_at": "2019-08-24T14:15:22Z",
  "enforcement_mode": "allow",
  "primary_property": "string",
  "is_action": true,
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "post_to_slack": false,
  "default_columns": [
    "string"
  ],
  "media_preview_urls": [
    "string"
  ]
}

Delete event definitions

Required API key scopes

event_definition:write

Path parameters

  • id
    string

Example request

DELETE /api/projects/:project_id/event_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/:id/

Example response

Status 204 No response body

Retrieve event definitions metrics

Path parameters

  • id
    string

Example request

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

Example response

Status 200 No response body

Create event definitions stop ingesting

Drop new events with this name at ingestion, then hide the definition and schedule its delete.

Adds an exact event name condition to the live event filter of each environment in the project, because the definition is shared by all of them. This never makes a team's own filter conditions live: if a filter is in dry run or turned off, or can't take one more condition, the request fails and nothing changes. Dropped events can't be recovered.

Required API key scopes

event_definition:writeevent_filter:write

Path parameters

  • id
    string

Response


Example request

POST /api/projects/:project_id/event_definitions/:id/stop_ingesting
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/:id/stop_ingesting/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "enforcement_mode": "allow",
  "primary_property": "string",
  "is_action": true,
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "post_to_slack": false
}

Create event definitions bulk update tags

Add, remove, or replace tags across multiple event definitions in one request.

Overrides TaggedItemViewSetMixin.bulk_update_tags, which assumes integer PKs and runs object-level access-control filtering. Event definitions use UUID PKs and are not an object-level access-controlled resource — project membership (enforced by the viewset) is the only boundary, matching the single-object update path — so this scopes by project and skips the per-object editor check. Tags live on the base EventDefinition row, so it operates there regardless of the enterprise extension.

Required API key scopes

event_definition:write

Request parameters

  • ids
    array
  • action
  • tags
    array

Response


Example request

POST /api/projects/:project_id/event_definitions/bulk_update_tags
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/bulk_update_tags/\
	-d ids="array",\
	-d action=undefined,\
	-d tags="array"

Example response

Status 200
RESPONSE
{
  "updated": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tags": [
        "string"
      ]
    }
  ],
  "skipped": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "reason": "string"
    }
  ]
}

Create event definitions bulk update verified

Mark multiple event definitions as verified or unverified in one request.

In the same vein as bulk_update_tags, but verified lives on the enterprise EnterpriseEventDefinition extension rather than the base row, so this action:

  • requires an enterprise license;
  • scopes by project (team__project_id) and relies on project membership — the same boundary the single-object update path uses — rather than object-level RBAC;
  • lazily promotes ingestion-created base rows to EnterpriseEventDefinition (mirroring _get_event_definition) before setting verified;
  • mirrors the single-object semantics: verifying stamps verified_by/verified_at and unhides the event (an event cannot be both hidden and verified); unverifying clears them;
  • logs a "changed" activity per event so the History tab matches the single-object path.

Events already in the target state are skipped (not re-written, not logged).

Required API key scopes

event_definition:write

Request parameters

  • ids
    array
  • verified
    boolean

Response


Example request

POST /api/projects/:project_id/event_definitions/bulk_update_verified
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/event_definitions/bulk_update_verified/\
	-d ids="array",\
	-d verified="boolean"

Example response

Status 200
RESPONSE
{
  "updated": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "verified": true
    }
  ],
  "skipped": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "reason": "string"
    }
  ]
}

Retrieve event definitions by name

Get event definition by exact name

Required API key scopes

event_definition:read

Query parameters

  • name
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "enforcement_mode": "allow",
  "primary_property": "string",
  "is_action": true,
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "post_to_slack": false
}

Retrieve event definitions golang

Required API key scopes

event_definition:read

Example request

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

Example response

Status 200 No response body

Retrieve event definitions primary properties

Resolve team-configured primary properties for event definitions.

The response only contains entries where a non-null primary_property is set on the EventDefinition. Callers should fall back to the core taxonomy defaults client-side for names not present in the response.

Required API key scopes

event_definition:read

Query parameters

  • names
    array

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "primary_properties": {
    "property1": "string",
    "property2": "string"
  }
}

Retrieve event definitions python

Required API key scopes

event_definition:read

Example request

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

Example response

Status 200 No response body

Retrieve event definitions typescript

Required API key scopes

event_definition:read

Example request

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

Example response

Status 200 No response body