List event definitions with the PostHog API

Lists the events tracked in the project with name, description, tags and last_seen_at, to use in queries and annotations. Page with limit and offset.

Identifier
posthog_list_event_definitions

The request

POST https://connect.reportei.com/api/tools/posthog_list_event_definitions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "project_id": "<project_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
project_idstringYesId of the project: the project_id of a team in List organizations, or the number after /project/ in the URL of PostHog.
searchstringNoCase-insensitive match on the event name. Every word has to match.
event_typestringNoevent, the default, returns all events. event_custom keeps only names without a $ prefix, and event_posthog only the PostHog events, with the $ prefix.Values: event, event_custom, event_posthog
exclude_stalebooleanNotrue leaves out the events not seen in the last 30 days.
limitintegerNoEvents per page. The default is 100.
offsetintegerNoIndex of the first event of the page.

Supported connections

Your customer connects their PostHog account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

When connecting, your customer also enters {region}: the address of their account on the app's API.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/posthog_list_event_definitions. It becomes your agent's tool definition with no conversion.

Other PostHog tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.