Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add PostHog tool guide #154

Merged
merged 3 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions docs/tools/posthog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# PostHog

The PostHog tool for Superface allows you to quickly add the following capabilities:

- Fetch session recording detail from the PostHog API using the Project ID and Session Recording ID.
- Retrieve a list of events for a specified project using its ID.
- Retrieve the list of projects for the current organization.
- Retrieve a list of session recordings for a specific project using the project ID.

## Requirements

You will need:

- A [PostHog](https://posthog.com) account
- A personal API key.
- The geographic location of your PostHog account (either US or EU).

## Authentication

Start by setting up a Personal API key in PostHog, that will allow Superface to access your account.

To do this, open your PostHog account settings and click on _User > Personal API Keys_.

![The Personal API Key section in PostHog](/img/tools/tools-posthog-personalapikey.png)

Click **Create personal API key** and set up a new API key specifically for Superface.

Next, in Superface, click on the config button for the PostHog tool.

![The PostHog setup in Superface](/img/tools/tools-posthog-superfacesetup.png)

Set the `DOMAIN` field in the Parameters section to either:

- `app` if your PostHog account is using their US Cloud location
- `eu` if using their EU location

Then enter the API key you created in the `Token` field.

Click on _Save Changes_ and the PostHog tool is ready to use.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Project IDs in PostHog

Some of the capabilities the PostHog tool offers require you to supply a `project_id`. You will be prompted to enter this in order to complete any tasks that require it. If you can't remember the project ID you can use the _"List Project IDs"_ prompt to see all the projects you have access to and their associated IDs.

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Show me a list of session recordings
- List Project IDs
- Show me events from the past 24 hours
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ module.exports = {
'tools/notion',
'tools/open-weather-map',
'tools/pipedrive',
'tools/posthog',
'tools/resend',
'tools/slack',
'tools/weather-api',
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tools/tools-posthog-superfacesetup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading