PostHog

Capture events, list events, and query persons in PostHog.

AnalyticsAPI key3 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (3)
create_event
create_project
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("posthog", "create_event", {
    "event": "<event name>",
    "event_type": "alias",
    "distinct_id": "<distinct id>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("PostHog answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "posthog-create-event",
  name: "PostHog: Create Event",
  description: "Calls PostHog when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("posthog", {
      "action": "create_event",
      "event": "<event name>",
      "event_type": "alias",
      "distinct_id": "<distinct id>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/posthog/create_event" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"event":"<event name>","event_type":"alias","distinct_id":"<distinct id>"}}'

Actions

create_eventin catalog

Create Event. Create an event inside a project

Input	Type	Description
`event`required	text	The event name
`event_type`required	one of "alias" \| "capture" \| "screen" \| "page" \| "screen"	Event type
`distinct_id`required	text	User's Distinct Id
`properties`optional	object	The event properties
`context`optional	object	The event context,
`message_id`optional	text	The message id,
`category`optional	text	The event category.

create_projectin catalog

Create Project. Create a posthog project

Input	Type	Description
`name`optional	text	Project Name
`slack_incoming_webhook`optional	text	Slack incoming webhook
`anonymize_ips`optional	boolean	Whether to anonymize incoming IP addresses.
`is_demo`optional	boolean	If this is a demo project

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: posthog
Category: Analytics
Tags: analytics, product, events, open-source
Package: @activepieces/piece-posthog@0.4.4
Tier: Community