event_definitions

Get event definition by exact name

get/api/projects/{project_id}/event_definitions/by_name/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/event_definitions/by_name/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

Query parameters

namestring required

The exact event name to look up

Response

idstring uuid required
namestring required
created_atstring date-time nullable
last_seen_atstring date-time nullable
last_updated_atstring date-time required
enforcement_mode'allow' | 'reject'
  • allow - Allow
  • reject - Reject
primary_propertystring nullable

Name of a single property on this event that PostHog UIs should display alongside the event (for example $pathname on $pageview). When set, surfaces like the session replay inspector show the property's value next to the event name without the user having to open the event.

is_actionboolean required
action_idinteger required
is_calculatingboolean required
last_calculated_atstring date-time required
post_to_slackboolean

Changes

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