customer_analytics
event_streams

The caller's event stream: a live feed of selected accounts' events posted to a Slack channel of their choice. Per-user — each team member owns at most one stream, and every endpoint is scoped to the caller's own. Delivery runs through a managed CDP destination that is re-provisioned inside the same transaction as every write, so config and delivery can't drift apart.

get/api/projects/{project_id}/event_streams/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/event_streams/
  • 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/.

Response

idstring uuid required
enabledboolean

Whether the stream delivers to Slack. Delivery also requires at least one event, at least one member account with an external ID, and a Slack workspace + channel.

event_namesstring[]

Names of the events to stream (matched exactly). Duplicates and blanks are dropped.

slack_integrationinteger nullable

ID of the team's Slack workspace integration to deliver through.

slack_channel_idstring

Slack channel ID to post to (e.g. C0123ABC).

slack_channel_namestring

Display name of the Slack channel (e.g. #customer-events). Informational only.

account_idsstring[] required

UUIDs of the member accounts whose users' events are streamed. Managed via the add_account/remove_account endpoints.

created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required

Changes

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