Event API Reference

List all 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.

Required API key scopes

account:read

Example request

GET /api/projects/:project_id/event_streams
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_streams/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/event_streams/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled": false,
  "event_names": [
    "string"
  ],
  "slack_integration": 0,
  "slack_channel_id": "",
  "slack_channel_name": "",
  "account_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Create 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.

Required API key scopes

account:write

Request parameters

enabled
boolean
Default: false
event_names
array
slack_integration
integer | null
slack_channel_id
string
Default:
slack_channel_name
string
Default:

Response

Example request

POST /api/projects/:project_id/event_streams
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_streams/\
	-d enabled="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/event_streams/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"enabled": "boolean"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled": false,
  "event_names": [
    "string"
  ],
  "slack_integration": 0,
  "slack_channel_id": "",
  "slack_channel_name": "",
  "account_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Update 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.

Required API key scopes

account:write

Path parameters

id
string

Request parameters

enabled
boolean
Default: false
event_names
array
slack_integration
integer | null
slack_channel_id
string
Default:
slack_channel_name
string
Default:

Response

Example request

PATCH /api/projects/:project_id/event_streams/: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_streams/:id/\
	-d enabled="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/event_streams/{event_stream_id}/".format(
        project_id=project_id,
		event_stream_id="<the event stream id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"enabled": "boolean"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled": false,
  "event_names": [
    "string"
  ],
  "slack_integration": 0,
  "slack_channel_id": "",
  "slack_channel_name": "",
  "account_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete 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.

Required API key scopes

account:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/event_streams/: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_streams/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/event_streams/{event_stream_id}/".format(
        project_id=project_id,
		event_stream_id="<the event stream id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create event streams add account

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.

Path parameters

id
string

Request parameters

account_id
string

Response

Example request

POST /api/projects/:project_id/event_streams/:id/add_account
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_streams/:id/add_account/\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/event_streams/{event_stream_id}/add_account/".format(
        project_id=project_id,
		event_stream_id="<the event stream id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"account_id": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled": false,
  "event_names": [
    "string"
  ],
  "slack_integration": 0,
  "slack_channel_id": "",
  "slack_channel_name": "",
  "account_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Create event streams remove account

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.

Path parameters

id
string

Request parameters

account_id
string

Response

Example request

POST /api/projects/:project_id/event_streams/:id/remove_account
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_streams/:id/remove_account/\
	-d account_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/event_streams/{event_stream_id}/remove_account/".format(
        project_id=project_id,
		event_stream_id="<the event stream id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"account_id": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled": false,
  "event_names": [
    "string"
  ],
  "slack_integration": 0,
  "slack_channel_id": "",
  "slack_channel_name": "",
  "account_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Create event streams send test message

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.

Path parameters

id
string

Response

Example request

POST /api/projects/:project_id/event_streams/:id/send_test_message
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_streams/:id/send_test_message/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/event_streams/{event_stream_id}/send_test_message/".format(
        project_id=project_id,
		event_stream_id="<the event stream id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "channel_id": "string"
}

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

Event

Endpoints

List all event streams

Required API key scopes

Example request

Example response

Status 200

Create event streams

Required API key scopes

Request parameters

Response

Example request

Example response

Status 201

Update event streams

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete event streams

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create event streams add account

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create event streams remove account

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Create event streams send test message

Path parameters

Response

Example request

Example response

Status 200