:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { urls } from 'scenes/urls'
import { AvailableSetupTaskIdsEnumApi as SetupTaskId } from '~/generated/core/api.schemas'
import { ProductKey } from '~/queries/schema/schema-general'
import { OnboardingStepKey, ReplayTabs } from '~/types'
import type { ProductSetupConfig, SetupTask } from './types'
// ============================================================================
// Shared Tasks - reusable across products
// ============================================================================
/** Ingest first event task - include in products that need event data */
export const INGEST_FIRST_EVENT = (productKey: ProductKey): SetupTask => ({
id: SetupTaskId.IngestFirstEvent,
title: 'Ingest your first event',
description: 'Get data flowing into PostHog by installing our SDK or connecting a data source.',
skipWarning: "Without events, your dashboards will be empty and you won't be able to explore PostHog.",
taskType: 'setup',
requiresManualCompletion: true,
getUrl: () => urls.onboarding({ productKey, stepKey: OnboardingStepKey.INSTALL }),
targetSelector: '[data-attr="menu-item-activity"]',
})
/** Set up reverse proxy task - improves data accuracy */
export const SET_UP_REVERSE_PROXY: SetupTask = {
id: SetupTaskId.SetUpReverseProxy,
title: 'Set up a reverse proxy',
description: 'Improve data accuracy by routing PostHog through your own domain.',
skipWarning: 'Without a reverse proxy, you might experience data loss from adblockers.',
taskType: 'setup',
getUrl: () => urls.settings('organization-proxy'),
}
/**
* AI tasks - appended to the end of every product's setup flow.
* These surface PostHog's AI capabilities regardless of which product the user onboards with.
*/
export const AI_TASKS: SetupTask[] = [
{
id: SetupTaskId.UsePosthogAi,
title: 'Try PostHog AI',
description:
"Ask Max, PostHog's AI assistant, to build insights, write SQL, and answer questions about your data.",
taskType: 'ai',
requiresManualCompletion: true,
getUrl: () => urls.ai(),
},
]
/** MCP and Slack tasks - add only to products where an agent or a Slack thread is a natural way to use them */
export const USE_POSTHOG_MCP: SetupTask = {
id: SetupTaskId.UsePosthogMcp,
title: 'Try PostHog MCP',
description:
'Query your PostHog data in plain English from your coding agent — run funnels, check errors, and toggle flags without leaving your editor.',
taskType: 'ai',
requiresManualCompletion: true,
docsUrl: 'https://posthog.com/mcp',
}
export const USE_POSTHOG_IN_SLACK: SetupTask = {
id: SetupTaskId.UsePosthogInSlack,
title: 'Try PostHog in Slack',
description:
'Tag @PostHog in any Slack thread to ask data questions, run SQL, and draft pull requests — plus get insights and alerts delivered to your channels.',
taskType: 'ai',
requiresManualCompletion: true,
getUrl: () => urls.integration('slack'),
}
// ============================================================================
// Product Setup Registry
// ============================================================================
export const PRODUCT_SETUP_REGISTRY: Partial<Record<ProductKey, ProductSetupConfig>> = {
[ProductKey.PRODUCT_ANALYTICS]: {
productKey: ProductKey.PRODUCT_ANALYTICS,
title: 'Get started with Product analytics',
tasks: [
INGEST_FIRST_EVENT(ProductKey.PRODUCT_ANALYTICS),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.CreateFirstInsight,
title: 'Create your first insight',
description: 'Choose from various insight types to analyze user behavior.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.insights(),
targetSelector: '[data-attr="saved-insights-new-insight-button"]',
},
{
id: SetupTaskId.ExploreTrendsInsight,
title: 'Create a trends insight',
description: 'Visualize how events or actions vary over time.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-trends"]',
},
{
id: SetupTaskId.CreateFunnel,
title: 'Create a funnel insight',
description: 'Track how users move through steps like signup → activation → purchase.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-funnels"]',
},
{
id: SetupTaskId.ExploreRetentionInsight,
title: 'Explore retention analysis',
description: 'See how many users return on subsequent days after an initial action.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-retention"]',
},
{
id: SetupTaskId.ExplorePathsInsight,
title: 'Explore user paths',
description: 'Trace the journeys users take within your product.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-paths"]',
},
{
id: SetupTaskId.ExploreStickinessInsight,
title: 'Explore stickiness',
description: 'See what keeps users coming back by viewing repeated actions.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-stickiness"]',
},
{
id: SetupTaskId.ExploreLifecycleInsight,
title: 'Explore lifecycle analysis',
description: 'Break down users into new, returning, resurrected, and dormant.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.insightQuickStart(),
targetSelector: '[data-attr="insight-option-lifecycle"]',
},
{
id: SetupTaskId.CreateFirstDashboard,
title: 'Create your first dashboard',
description: 'Combine multiple insights into a dashboard to monitor key metrics.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.CreateFirstInsight],
getUrl: () => urls.dashboards(),
targetSelector: '[data-attr="new-dashboard"]',
},
{
id: SetupTaskId.TrackCustomEvents,
title: 'Track custom events',
description: 'Go beyond autocapture by tracking specific actions that matter.',
taskType: 'explore',
dependsOn: [SetupTaskId.IngestFirstEvent],
requiresManualCompletion: true,
docsUrl: 'https://posthog.com/tutorials/event-tracking-guide#setting-up-custom-events',
targetSelector: '[data-attr="help-button"]',
},
{
id: SetupTaskId.DefineActions,
title: 'Define actions',
description: 'Group related events into actions for easier analysis.',
taskType: 'explore',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.actions(),
targetSelector: '[data-attr="create-action"]',
},
{
id: SetupTaskId.SetUpCohorts,
title: 'Create a user cohort',
description: 'Group users based on behavior or properties for targeted analysis.',
taskType: 'explore',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.cohorts(),
targetSelector: '[data-attr="new-cohort"]',
},
USE_POSTHOG_MCP,
USE_POSTHOG_IN_SLACK,
],
},
[ProductKey.WEB_ANALYTICS]: {
productKey: ProductKey.WEB_ANALYTICS,
title: 'Get started with Web analytics',
tasks: [
INGEST_FIRST_EVENT(ProductKey.WEB_ANALYTICS),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.AddAuthorizedDomain,
title: 'Add your domain',
description: 'Authorize your website domain to enable accurate traffic tracking.',
skipWarning: "Without a domain, you can't use the toolbar or categorize traffic properly.",
taskType: 'setup',
getUrl: () => urls.settings('environment-web-analytics'),
targetSelector: '[data-attr="toolbar-add-url"]',
},
{
id: SetupTaskId.SetUpWebVitals,
title: 'Enable web vitals',
description: 'Track Core Web Vitals (LCP, FID, CLS) to monitor site performance.',
taskType: 'setup',
getUrl: () => urls.settings('environment-autocapture'),
targetSelector: '#posthog-autocapture-web-vitals-switch',
},
{
id: SetupTaskId.ReviewWebAnalyticsDashboard,
title: 'Review your dashboard',
description: 'Explore pageviews, sessions, and user sources.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.webAnalytics(),
targetSelector: '[data-attr="web-analytics-dashboard"]',
},
{
id: SetupTaskId.FilterWebAnalytics,
title: 'Filter your analytics',
description: 'Filter data to focus on what matters to you.',
taskType: 'explore',
getUrl: () => urls.webAnalytics(),
targetSelector: '[data-attr="web-analytics-unified-filters"]',
},
{
id: SetupTaskId.SetUpWebAnalyticsConversionGoals,
title: 'Set up conversion goals',
description: 'Track important conversions like signups or purchases.',
taskType: 'explore',
getUrl: () => urls.webAnalytics(),
targetSelector: '[data-attr="web-analytics-conversion-filter"]',
},
{
id: SetupTaskId.VisitWebVitalsDashboard,
title: 'Visit your web vitals dashboard',
description: 'Monitor your site performance over time.',
taskType: 'explore',
getUrl: () => urls.webAnalyticsWebVitals(),
},
USE_POSTHOG_IN_SLACK,
],
},
[ProductKey.SESSION_REPLAY]: {
productKey: ProductKey.SESSION_REPLAY,
title: 'Get started with Session replay',
tasks: [
INGEST_FIRST_EVENT(ProductKey.SESSION_REPLAY),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.SetupSessionRecordings,
title: 'Enable session recordings',
description: 'Turn on recording to capture user interactions.',
skipWarning: 'Without recordings enabled, you cannot use session replay.',
taskType: 'setup',
getUrl: () => urls.replaySettings('replay'),
targetSelector: '[data-attr="settings-menu-item-replay"]',
},
{
id: SetupTaskId.ConfigureRecordingSettings,
title: 'Configure recording settings',
description: 'Customize sampling rate, privacy masking, and network capture.',
taskType: 'setup',
dependsOn: [SetupTaskId.SetupSessionRecordings],
getUrl: () => urls.replaySettings('replay-triggers'),
targetSelector: '[data-attr="settings-menu-item-replay-triggers"]',
},
{
id: SetupTaskId.EnableConsoleLogs,
title: 'Enable console log capture',
description: 'See JavaScript console logs alongside recordings for debugging.',
taskType: 'setup',
dependsOn: [SetupTaskId.SetupSessionRecordings],
getUrl: () => urls.replaySettings('replay'),
targetSelector: '[data-attr="opt-in-capture-console-log-switch"]',
},
{
id: SetupTaskId.WatchSessionRecording,
title: 'Watch your first recording',
description: 'See exactly how a real user interacted with your product.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.SetupSessionRecordings],
getUrl: () => urls.replay(ReplayTabs.Home),
targetSelector: '[data-attr="session-recordings-playlist"]',
},
{
id: SetupTaskId.CreateRecordingPlaylist,
title: 'Create a recording playlist',
description: 'Save filtered recordings for specific user journeys or issues.',
taskType: 'explore',
dependsOn: [SetupTaskId.SetupSessionRecordings],
getUrl: () => urls.replay(ReplayTabs.Playlists),
targetSelector: '[data-attr="save-recordings-playlist-button"]',
},
],
},
[ProductKey.FEATURE_FLAGS]: {
productKey: ProductKey.FEATURE_FLAGS,
title: 'Get started with Feature flags',
tasks: [
INGEST_FIRST_EVENT(ProductKey.FEATURE_FLAGS),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.CreateFeatureFlag,
title: 'Create your first feature flag',
description: 'Create a flag to control feature rollouts without deploying.',
taskType: 'onboarding',
getUrl: () => urls.featureFlag('new'),
targetSelector: '[data-attr="new-feature-flag"]',
},
{
id: SetupTaskId.ImplementFlagInCode,
title: 'Implement flag in your code',
description: 'Add the feature flag check to your application.',
taskType: 'onboarding',
requiresManualCompletion: true,
dependsOn: [SetupTaskId.CreateFeatureFlag],
docsUrl: 'https://posthog.com/docs/feature-flags/installation',
targetSelector: '[data-attr="help-button"]',
},
{
id: SetupTaskId.UpdateFeatureFlagReleaseConditions,
title: 'Configure release conditions',
description: 'Target specific users or percentages with your flag.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFeatureFlag],
docsUrl: 'https://posthog.com/docs/feature-flags/creating-feature-flags#release-conditions',
},
{
id: SetupTaskId.CreateMultivariateFlag,
title: 'Create a multivariate flag',
description: 'Test multiple variants with different user groups.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFeatureFlag],
getUrl: () => urls.featureFlags(),
targetSelector: '[data-attr="new-feature-flag"]',
},
{
id: SetupTaskId.SetUpFlagPayloads,
title: 'Use flag payloads',
description: 'Pass dynamic configuration to your feature flags.',
taskType: 'explore',
docsUrl: 'https://posthog.com/docs/feature-flags/creating-feature-flags#payloads',
},
{
id: SetupTaskId.SetUpFlagEvaluationRuntimes,
title: 'Set up flag evaluation runtimes',
description: 'Control where your feature flags can be evaluated.',
taskType: 'explore',
docsUrl:
'https://posthog.com/docs/feature-flags/creating-feature-flags#step-5-configure-evaluation-runtime-and-contexts-optional',
},
USE_POSTHOG_MCP,
],
},
[ProductKey.EXPERIMENTS]: {
productKey: ProductKey.EXPERIMENTS,
title: 'Get started with Experiments',
tasks: [
INGEST_FIRST_EVENT(ProductKey.EXPERIMENTS),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.CreateExperiment,
title: 'Create your first experiment',
description: 'Set up an A/B test to measure the impact of a change.',
taskType: 'onboarding',
getUrl: () => urls.experiments(),
targetSelector: '[data-attr="create-experiment"]',
},
{
id: SetupTaskId.ImplementExperimentVariants,
title: 'Implement experiment variants in your code',
description: 'Add code to show different variants to users.',
taskType: 'onboarding',
requiresManualCompletion: true,
dependsOn: [SetupTaskId.CreateExperiment],
docsUrl: 'https://posthog.com/docs/experiments/installation',
},
{
id: SetupTaskId.LaunchExperiment,
title: 'Launch your experiment',
description: 'Start collecting data by launching your experiment.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.ImplementExperimentVariants],
getUrl: () => urls.experiments(),
targetSelector: '[data-attr="launch-experiment"]', // Will be highlighted once they click on an experiment
},
{
id: SetupTaskId.ReviewExperimentResults,
title: 'Review experiment results',
description: 'Analyze the statistical significance and impact.',
taskType: 'explore',
dependsOn: [SetupTaskId.LaunchExperiment],
},
USE_POSTHOG_MCP,
],
},
[ProductKey.SURVEYS]: {
productKey: ProductKey.SURVEYS,
title: 'Get started with Surveys',
tasks: [
INGEST_FIRST_EVENT(ProductKey.SURVEYS),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.CreateSurvey,
title: 'Create your first survey',
description: 'Choose from templates or build a custom survey.',
taskType: 'onboarding',
getUrl: () => urls.surveys(),
targetSelector: '[data-attr="new-survey"]',
},
{
id: SetupTaskId.LaunchSurvey,
title: 'Launch your survey',
description: 'Make your survey live and start collecting responses.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateSurvey],
getUrl: () => urls.surveys(),
targetSelector: '[data-attr="launch-survey"]', // Will be highlighted once they click on a survey
},
],
},
[ProductKey.DATA_WAREHOUSE]: {
productKey: ProductKey.DATA_WAREHOUSE,
title: 'Get started with Data warehouse',
tasks: [
{
id: SetupTaskId.ConnectSource,
title: 'Connect your first data source',
description: 'Import data from Stripe, Hubspot, Postgres, or other sources.',
skipWarning: "Without a data source, you can't query data in the warehouse.",
taskType: 'setup',
getUrl: () => urls.dataWarehouseSourceNew(),
targetSelector: '[data-attr="new-source-button"]',
},
{
id: SetupTaskId.RunFirstQuery,
title: 'Run your first SQL query',
description: 'Query your data using SQL in the data warehouse.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.ConnectSource],
getUrl: () => urls.sqlEditor(),
targetSelector: '[data-attr="sql-editor-button"]',
},
{
id: SetupTaskId.JoinExternalData,
title: 'Join external data with events',
description: 'Combine PostHog events with external data.',
taskType: 'explore',
dependsOn: [SetupTaskId.RunFirstQuery],
getUrl: () => urls.sqlEditor(),
targetSelector: '[data-attr="sql-editor-button"]',
},
{
id: SetupTaskId.CreateSavedView,
title: 'Save a view for reuse',
description: 'Create a saved view from a query to use in insights.',
taskType: 'explore',
dependsOn: [SetupTaskId.RunFirstQuery],
getUrl: () => urls.sqlEditor(),
targetSelector: '[data-attr="sql-editor-save-options-button"]',
},
],
},
[ProductKey.ERROR_TRACKING]: {
productKey: ProductKey.ERROR_TRACKING,
title: 'Get started with Error tracking',
tasks: [
INGEST_FIRST_EVENT(ProductKey.ERROR_TRACKING),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.EnableErrorTracking,
title: 'Enable error tracking',
description: 'Start capturing exceptions and errors from your app.',
skipWarning: "Error tracking isn't enabled by default.",
taskType: 'setup',
requiresManualCompletion: true,
getUrl: () =>
urls.onboarding({ productKey: ProductKey.ERROR_TRACKING, stepKey: OnboardingStepKey.INSTALL }),
targetSelector: '[data-attr="menu-item-error_tracking"]',
},
{
id: SetupTaskId.UploadSourceMaps,
title: 'Upload source maps',
description: 'See readable stack traces instead of minified code.',
skipWarning: "Without source maps, stack traces won't be readable.",
taskType: 'setup',
requiresManualCompletion: true,
docsUrl: 'https://posthog.com/docs/error-tracking/upload-source-maps',
targetSelector: '[data-attr="help-button"]',
},
{
id: SetupTaskId.ViewFirstError,
title: 'View your first error',
description: 'Explore error details including stack trace and user context.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.EnableErrorTracking],
getUrl: () => urls.errorTracking(),
targetSelector: '[data-attr="error-tracking-issue-row"]',
},
{
id: SetupTaskId.ResolveFirstError,
title: 'Resolve an error',
description: 'Mark an error as resolved to track your fix rate.',
taskType: 'explore',
dependsOn: [SetupTaskId.ViewFirstError],
getUrl: () => urls.errorTracking(),
targetSelector: '[data-attr="error-tracking-resolve"]', // Will be highlighted once they click on an error
},
USE_POSTHOG_MCP,
],
},
[ProductKey.AI_OBSERVABILITY]: {
productKey: ProductKey.AI_OBSERVABILITY,
title: 'Get started with AI observability',
tasks: [
{
id: SetupTaskId.IngestFirstLlmEvent,
title: 'Send your first AI event',
description: 'Install the PostHog LLM SDK to start tracking AI usage.',
skipWarning: "Without AI events, you can't track AI model usage.",
taskType: 'setup',
getUrl: () =>
urls.onboarding({ productKey: ProductKey.AI_OBSERVABILITY, stepKey: OnboardingStepKey.INSTALL }),
targetSelector: '[data-attr="menu-item-llm_analytics"]',
},
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.ViewFirstTrace,
title: 'View your first trace',
description: 'See a complete AI request trace with prompts and latency.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.aiObservabilityTraces(),
targetSelector: '[data-attr="llm-trace-table"]',
},
{
id: SetupTaskId.TrackCosts,
title: 'Track AI costs and usage',
description: 'Monitor AI spending and usage by model and use case.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.IngestFirstEvent],
getUrl: () => urls.aiObservabilityDashboard(),
},
{
id: SetupTaskId.SetUpLlmEvaluation,
title: 'Set up LLM evaluation',
description: 'Score and evaluate AI outputs for quality.',
taskType: 'explore',
getUrl: () => urls.aiObservabilityEvaluations(),
},
{
id: SetupTaskId.RunAiPlayground,
title: 'Run your first AI playground',
description: 'Test and refine your AI prompts with real-time feedback.',
taskType: 'explore',
getUrl: () => urls.aiObservabilityPlayground(),
targetSelector: '[data-attr="ai-playground-run-button"]',
},
],
},
[ProductKey.LOGS]: {
productKey: ProductKey.LOGS,
title: 'Get started with Logs',
tasks: [
{
id: SetupTaskId.EnableLogCapture,
title: 'Enable log capture',
description: 'Start sending logs from your application to PostHog.',
taskType: 'setup',
requiresManualCompletion: true,
getUrl: () => urls.onboarding({ productKey: ProductKey.LOGS, stepKey: OnboardingStepKey.INSTALL }),
docsUrl: 'https://posthog.com/docs/logs',
targetSelector: '[data-attr="menu-item-logs"]',
},
{
id: SetupTaskId.ViewFirstLogs,
title: 'View your logs',
description: 'Explore application logs with filtering and search.',
taskType: 'onboarding',
dependsOn: [SetupTaskId.EnableLogCapture],
getUrl: () => urls.logs(),
},
],
},
[ProductKey.WORKFLOWS]: {
productKey: ProductKey.WORKFLOWS,
title: 'Get started with Workflows',
tasks: [
{
id: SetupTaskId.SetUpFirstWorkflowChannel,
title: 'Set up your first workflows channel',
description: 'Connect a channel like email, Slack, or Twilio for sending messages.',
taskType: 'onboarding',
getUrl: () => urls.workflows('channels'),
targetSelector: '[data-attr="new-channel-button"]',
},
{
id: SetupTaskId.CreateFirstWorkflow,
title: 'Create your first workflow',
description: 'Build an automated workflow to engage users.',
taskType: 'onboarding',
getUrl: () => urls.workflows(),
targetSelector: '[data-attr="new-workflow"]',
},
{
id: SetupTaskId.ConfigureWorkflowTrigger,
title: 'Configure a trigger',
description: 'Define when your workflow should start.',
taskType: 'onboarding',
targetSelector: '[data-attr="workflow-trigger"]', // Will be highlighted once they are inside a workflow
},
{
id: SetupTaskId.AddWorkflowAction,
title: 'Add an action',
description: 'Add actions like emails, Slack messages, or webhooks.',
taskType: 'onboarding',
targetSelector: '[data-attr="workflow-add-action"]', // Will be highlighted once they are inside a workflow
},
{
id: SetupTaskId.LaunchWorkflow,
title: 'Launch your workflow',
description: 'Activate your workflow to start engaging users.',
taskType: 'onboarding',
dependsOn: [
SetupTaskId.CreateFirstWorkflow,
SetupTaskId.ConfigureWorkflowTrigger,
SetupTaskId.AddWorkflowAction,
],
targetSelector: '[data-attr="workflow-launch"]', // Will be highlighted once they click on a workflow
},
],
},
[ProductKey.ENDPOINTS]: {
productKey: ProductKey.ENDPOINTS,
title: 'Get started with Endpoints',
tasks: [
{
id: SetupTaskId.CreateFirstEndpoint,
title: 'Create your first endpoint',
description: 'Build an API endpoint to expose PostHog data.',
taskType: 'onboarding',
getUrl: () => urls.endpoints(),
targetSelector: '[data-attr="new-endpoint-button"]',
},
{
id: SetupTaskId.ConfigureEndpoint,
title: 'Configure your endpoint',
description: 'Configure your endpoint caching and materialization mechanisms.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstEndpoint],
targetSelector: '[data-attr="endpoint-configuration-tab"]', // Will be highlighted once they are inside an endpoint
},
{
id: SetupTaskId.TestEndpoint,
title: 'Test your endpoint',
description: 'Use the playground to test with different parameters.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateFirstEndpoint],
targetSelector: '[data-attr="endpoint-playground-tab"]', // Will be highlighted once they are inside an endpoint
},
],
},
[ProductKey.EARLY_ACCESS_FEATURES]: {
productKey: ProductKey.EARLY_ACCESS_FEATURES,
title: 'Get started with Early access features',
tasks: [
INGEST_FIRST_EVENT(ProductKey.EARLY_ACCESS_FEATURES),
SET_UP_REVERSE_PROXY,
{
id: SetupTaskId.CreateEarlyAccessFeature,
title: 'Create an early access feature',
description: 'Set up a feature users can opt into before release.',
taskType: 'onboarding',
getUrl: () => urls.earlyAccessFeatures(),
targetSelector: '[data-attr="create-feature"]',
},
{
id: SetupTaskId.UpdateFeatureStage,
title: 'Update feature stage',
description: 'Progress through: draft → concept → alpha → beta → GA.',
taskType: 'explore',
dependsOn: [SetupTaskId.CreateEarlyAccessFeature],
targetSelector: '[data-attr="feature-stage"]', // Will be highlighted once they are inside a feature
},
],
},
}
// ============================================================================
// Helper Functions
// ============================================================================
/** Get the setup config for a product, or null if not configured */
export function getProductSetupConfig(productKey: ProductKey): ProductSetupConfig | null {
return PRODUCT_SETUP_REGISTRY[productKey] ?? null
}
/** Get all tasks for a product, optionally filtered by type. AI_TASKS are appended to every product, ahead of the product's own AI tasks. */
export function getTasksForProduct(
productKey: ProductKey,
taskType?: 'setup' | 'onboarding' | 'explore' | 'ai' | 'all'
): SetupTask[] {
const config = getProductSetupConfig(productKey)
if (!config) {
return []
}
const tasks = [
...config.tasks.filter((t) => t.taskType !== 'ai'),
...AI_TASKS,
...config.tasks.filter((t) => t.taskType === 'ai'),
]
if (!taskType || taskType === 'all') {
return tasks
}
return tasks.filter((t) => t.taskType === taskType)
}
/** List of products that have setup flows configured */
export const PRODUCTS_WITH_SETUP: ProductKey[] = Object.keys(PRODUCT_SETUP_REGISTRY) as ProductKey[]