https://github.com/posthog/user-interview-app
https://github.com/posthog/user-interview-app
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/posthog/user-interview-app
- Owner: PostHog
- Created: 2022-11-29T18:06:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-02T16:59:08.000Z (over 2 years ago)
- Last Synced: 2025-07-17T21:29:58.839Z (6 months ago)
- Language: TypeScript
- Size: 852 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User Interview App
Invite your users to an interview through an in-app pop-up with this app.
## Installation
1. Make sure you have enabled `opt_in_site_apps: true` in your posthog-js config.
2. Install the app from the PostHog App Repository
3. Customize the text and theme using the app config
4. Create a feature flag starting with `interview-` with the booking link as a payload and the appropriate filters set [instructions here](https://posthog.com/docs/apps/user-interview)
### Handling overlapping widgets
If there are other widgets in the bottom right hand corner:
- For when the widget opens:
- Add an event listener to the window that hides the other widgets e.g. `PHUserInterviewBoxOpened` and show it again with the `PHUserInterviewBoxClosed` event. For example:
```
window.addEventListener('PHUserInterviewBoxOpened', function (e) {
window.OtherWidget.hide();
});
window.addEventListener('PHUserInterviewBoxClosed', function (e) {
window.OtherWidget.show();
});
## Demo
## Tracking events
| Event name | Properties | Notes |
| ---------- | ----------- | ----------- |
| `User Interview Shown Pop Up` | `{featureFlagName: featureFlagName}` | |
| `User Interview Dismissed Pop Up` | `{featureFlagName: featureFlagName}` | |
| `User Interview Clicked Book Button` | `{featureFlagName: featureFlagName}` | |
| `User Interview Booked` | `{featureFlagName: featureFlagName}` | Requires the redirect after booking to be setup |
## User properties
| Property name | Notes |
| ------------- | ----------- |
| `Seen User Interview Invitation - {featureFlagName}` | Date when the user interview invitation was shown |
| `Seen User Interview Invitation` | Date when any user interview invitation was last shown |
## Local development
For local development, clone the repo and run
```bash
npx @posthog/app-dev-server
```
or
```bash
pnpm install
pnpm start
```