# Userpilot Knowledge Base

## Docs

- [Accessibility in Userpilot in-app messages](https://docs.userpilot.com/accessibility/accessibility-in-userpilot-in-app-messages.md): Learn how Userpilot supports accessible in-app messages by aligning with WCAG 2.1 Level AA standards, helping teams build inclusive user experiences.
- [Admin Console](https://docs.userpilot.com/admin-console/overview.md): All users who have Userpilot installed on more than one application have access to the Admin Console. Additional applications can be added to your plan.
- [Authentication](https://docs.userpilot.com/api-references/authentication.md): Userpilot APIs use API tokens to authenticate requests. You can view and manage your API key in the Environment Page of your Userpilot dashboard.
- [Bulk Identify/Update Companies](https://docs.userpilot.com/api-references/bulk-updates/companies.md): Bulk identify and update company profiles using Userpilot's HTTP API for large-scale company data synchronization.
- [Bulk Identify/Update Users](https://docs.userpilot.com/api-references/bulk-updates/users.md): Bulk identify and update user profiles using Userpilot's HTTP API for large-scale user data synchronization.
- [Delete Users and Companies](https://docs.userpilot.com/api-references/delete/overview.md): Delete users and companies from Userpilot to comply with data privacy regulations.
- [Bulk Companies Update](https://docs.userpilot.com/api-references/endpoints/bulk/companies.md): Create or update multiple company profiles in a single API request using the bulk_identify endpoint.
- [Bulk Users Update](https://docs.userpilot.com/api-references/endpoints/bulk/users.md): Create or update multiple user profiles in a single API request using the bulk_identify endpoint.
- [Export Job](https://docs.userpilot.com/api-references/endpoints/export/export-job.md): Create a bulk export job to extract user, company, or event data with customizable date ranges and filters.
- [Import Job](https://docs.userpilot.com/api-references/endpoints/import/import-job.md): Create a bulk import job to upload historical user, company, or event data from external systems.
- [View Job ID](https://docs.userpilot.com/api-references/endpoints/jobs/job-id.md): Get the status, progress, and results of a specific background job by its unique identifier.
- [List Jobs](https://docs.userpilot.com/api-references/endpoints/jobs/list.md): Retrieve a paginated list of background jobs including imports and exports with their status and metadata.
- [Banners](https://docs.userpilot.com/api-references/endpoints/lookups/banners.md): List all banners with their IDs and names for filtering analytics exports by specific announcement campaigns.
- [Checklists](https://docs.userpilot.com/api-references/endpoints/lookups/checklists.md): List all checklists with their IDs and names for filtering analytics exports by onboarding progress data.
- [Company Properties](https://docs.userpilot.com/api-references/endpoints/lookups/company-properties.md): Retrieve all available company properties and their metadata for use in analytics exports and B2B segmentation.
- [Features & Events](https://docs.userpilot.com/api-references/endpoints/lookups/features-events.md): List all tracked features and events with their IDs for filtering analytics exports by specific user actions.
- [Flows](https://docs.userpilot.com/api-references/endpoints/lookups/flows.md): List all flows with their IDs and names for filtering analytics exports by specific in-app experiences.
- [Resource Center Modules](https://docs.userpilot.com/api-references/endpoints/lookups/resource-center-modules.md): List all Resource Center modules with their IDs for filtering analytics exports by help content engagement.
- [Segments](https://docs.userpilot.com/api-references/endpoints/lookups/segments.md): List all user segments with their IDs and names for filtering analytics exports by specific audience groups.
- [Spotlights](https://docs.userpilot.com/api-references/endpoints/lookups/spotlights.md): List all spotlights with their IDs and names for filtering analytics exports by tooltip and hotspot interactions.
- [Surveys](https://docs.userpilot.com/api-references/endpoints/lookups/surveys.md): List all surveys with their IDs and names for filtering analytics exports by feedback collection campaigns.
- [User Properties](https://docs.userpilot.com/api-references/endpoints/lookups/user-properties.md): Retrieve all available user properties and their metadata for use in analytics exports and segmentation filters.
- [Identify Company](https://docs.userpilot.com/api-references/endpoints/realtime/identify-company.md): Create or update a company profile with properties like name, industry, and size via HTTP POST request.
- [Identify User](https://docs.userpilot.com/api-references/endpoints/realtime/identify-user.md): Create or update a user profile with properties like name, email, and custom attributes via HTTP POST request.
- [Track Event](https://docs.userpilot.com/api-references/endpoints/realtime/track-event.md): Record a custom event for a user with optional metadata properties via HTTP POST request.
- [Environment](https://docs.userpilot.com/api-references/environment.md): Userpilot APIs are available at different endpoint URLs depending on your hosting environment. Most users will use the default endpoint, but Enterprise and EU.
- [Event Schema](https://docs.userpilot.com/api-references/export/event-schema.md): Welcome to the Userpilot Event Data Schema documentation! This guide provides a comprehensive overview of the structure, attributes, and relationships of.
- [Data Lookups](https://docs.userpilot.com/api-references/export/lookups.md): The Lookups APIs allow you to retrieve metadata about various entities in your Userpilot account, such as user properties, company properties, features,.
- [Bulk Data Export API](https://docs.userpilot.com/api-references/export/overview.md): This feature is available on the Enterprise plan only or as an add-on to the Growth plan. If interested in adding this feature please contact.
- [User & Company Accumulative Properties Best Practices](https://docs.userpilot.com/api-references/import/best-practices.md): When importing historical data, it is crucial to ensure the consistency and accuracy of user and company data in Userpilot.
- [Event Schema](https://docs.userpilot.com/api-references/import/event-schema.md): This page documents the event types and required fields for importing data into Userpilot using the Import API.
- [Events Bulk Import](https://docs.userpilot.com/api-references/import/overview.md): The Import API allows you to import historical user data from other platforms into Userpilot. With this API, you can migrate data related to user and company.
- [Row Validation Rules](https://docs.userpilot.com/api-references/import/row-validation.md): When preparing your HTTP import file, ensure that each row adheres to the following validation rules:.
- [Userpilot API Documentation](https://docs.userpilot.com/api-references/overview.md): Welcome to Userpilot's comprehensive API suite! This guide helps you understand the different ways to integrate with Userpilot, choose the right API for your needs, and get the most out of our platform's capabilities.
- [Identify Company](https://docs.userpilot.com/api-references/real-time/identify-company.md): Identify and update company profiles in real time or in bulk using Userpilot's HTTP API.
- [Identify User](https://docs.userpilot.com/api-references/real-time/identify-user.md): The Identify User API allows you to create or update user profiles in real time, either individually or in bulk. Use this API to keep your user data in sync with Userpilot for analytics, segmentation, and personalized experiences.
- [Overview](https://docs.userpilot.com/api-references/real-time/overview.md): Real-time HTTP APIs for user and company identification and event tracking in Userpilot.
- [Track Event](https://docs.userpilot.com/api-references/real-time/track-event.md): Record custom events for users via HTTP API to monitor actions, feature usage, and engagement for analytics, segmentation, and content triggering.
- [Building your Workflow](https://docs.userpilot.com/building-your-workflow.md): Workflows in Userpilot allow you to design and automate multi-step user journeys across your product. Using a drag-and-drop builder, you can connect content, data updates, and logic into a single, easy-to-understand sequence — complete with branching conditions, time delays, and automatic property u…
- [AI Assistant](https://docs.userpilot.com/ce-basics/ai-assistant.md): Use Userpilot's AI Assistant to generate, refine, and optimize in-app copy instantly, improving clarity, engagement, and consistency across flows.
- [Button Actions](https://docs.userpilot.com/ce-basics/button-actions.md): Use Button Actions in Userpilot to control what happens when users click a button, navigate steps, trigger flows, open URLs, or run custom logic.
- [Embeds](https://docs.userpilot.com/ce-basics/embeds.md): Embed third-party tools like Calendly, Loom, Typeform, and Synthesia directly into Userpilot flows to deliver rich, interactive in-app experiences.
- [Personalize Content](https://docs.userpilot.com/ce-basics/personalize-content.md): Personalize Userpilot flows with dynamic variables to show tailored content for each user, increasing relevance, engagement, and overall product adoption.
- [Create & Preview Content](https://docs.userpilot.com/ce-basics/preview-content.md): Creating, managing, and previewing content can be done directly with the Userpilot Chrome Extension on your web app for Flows, Spotlights, Banners, and Events.
- [Select The Right Element](https://docs.userpilot.com/ce-basics/select-element.md): Learn how to accurately select and detect UI elements in Userpilot to ensure flows, tooltips, and product tours attach to the right components.
- [Switching Themes](https://docs.userpilot.com/ce-basics/switching-themes.md): Switch themes in Userpilot to control the look and feel of your flows globally or per step, ensuring consistent branding or contextual visual customization.
- [UI Templates](https://docs.userpilot.com/ce-basics/ui-templates.md): Save and reuse UI pattern templates in Userpilot to apply consistent styles, layouts, and settings across multiple flow steps and experiences.
- [Data Capture & Privacy](https://docs.userpilot.com/configure/data-capture-and-privacy/data-capture-and-privacy.md): The Data Capture & Privacy settings allow you to configure how user interaction data is collected, recorded, masked, and restricted across features like Session Replay and Auto-capture (raw events).
- [Excluding Dynamic Class Names, IDs and Attributes](https://docs.userpilot.com/configure/exclude-lists/dynamic-attributes.md): Dynamically generated class names, IDs, and attributes in JavaScript frameworks like React.js and Ember.js can hinder Userpilot's ability to target elements.
- [Exclude Users and Companies](https://docs.userpilot.com/configure/exclude-lists/exclude-user.md): Exclude specific users or companies from Userpilot analytics or from seeing in-app messages to keep your reports accurate and ensure insights reflect real end-user behavior.
- [Digest notification](https://docs.userpilot.com/configure/notifications/digest.md): Use Digest notifications in Userpilot to receive scheduled summaries of key product insights, engagement metrics, and feedback via email or Slack.
- [Get started with notifications](https://docs.userpilot.com/configure/notifications/get-started-with-notifications.md): Get started with Userpilot notifications to stay aligned on product updates, performance insights, and system alerts via in-app, email, or Slack.
- [Signal notifications](https://docs.userpilot.com/configure/notifications/signals.md): Use Signal notifications in Userpilot to alert your team about key in-app events in real time or on a schedule via in-app, email, or Slack.
- [System notifications](https://docs.userpilot.com/configure/notifications/system-notifications.md): Use System Notifications in Userpilot to stay informed about data health, content updates, and engagement events via in-app, email, or Slack alerts.
- [Two-Factor Authentication (2FA)](https://docs.userpilot.com/configure/team-and-roles/2fa.md): Enable Two-Factor Authentication (2FA) in Userpilot to add an extra layer of security and protect your workspace from unauthorized access.
- [Access and activity logs](https://docs.userpilot.com/configure/team-and-roles/access-and-activity-logs.md): Use Access and Activity Logs in Userpilot to monitor workspace access, track admin actions, and maintain security with detailed, auditable records.
- [Managing your team in Userpilot](https://docs.userpilot.com/configure/team-and-roles/managing-your-team-in-userpilot.md): Manage teammates in Userpilot by inviting users, assigning roles and permissions, tracking activity, and securing access with authentication controls.
- [SCIM Integration](https://docs.userpilot.com/configure/team-and-roles/scim.md): Automate user provisioning and deprovisioning in Userpilot using SCIM with identity providers like Okta and Azure AD.
- [SSO](https://docs.userpilot.com/configure/team-and-roles/sso.md): Enable Single Sign-On (SSO) in Userpilot to let users authenticate securely with a single set of credentials via Okta, Azure, Google, or other identity providers.
- [Get started](https://docs.userpilot.com/configure/themes-and-design-library/get-started.md): Get started with Userpilot Themes and Design Library to create brand-aligned, consistent in-app experiences across modals, tooltips, banners, surveys, and more.
- [Set up a design library](https://docs.userpilot.com/configure/themes-and-design-library/set-up-a-design-library.md): Set up a Design Library in Userpilot to centralize brand styles, reuse approved design tokens, and maintain consistent, on-brand in-app experiences at scale.
- [Set up a mobile app theme](https://docs.userpilot.com/configure/themes-and-design-library/set-up-a-mobile-app-theme.md): Set up a mobile app theme in Userpilot to customize colors, fonts, and buttons, ensuring consistent, on-brand mobile experiences across devices.
- [Set up a web app theme](https://docs.userpilot.com/configure/themes-and-design-library/set-up-a-web-app-theme.md): Set up a web app theme in Userpilot to customize colors, fonts, and UI styles, ensuring consistent, brand-aligned in-app experiences.
- [Theme Switching](https://docs.userpilot.com/configure/themes-and-design-library/switching-themes.md): Learn how to switch themes like light and dark mode in Userpilot using userpilot.theme() to match your app UI in real time.
- [Raw Events](https://docs.userpilot.com/data-events/autocapture/raw-events.md): Userpilot can automatically capture events using the raw events auto-capturing feature, which captures events like Clicks, Text Inputs, and Form Submissions.
- [Labeled Events (Visually/CSS)](https://docs.userpilot.com/data-events/autocapture/visual-labeler.md): Label and track user interactions like clicks, text inputs, and form submissions without code using the Visual Labeler or CSS selectors.
- [Events Dashboard](https://docs.userpilot.com/data-events/events-dashboard.md): To make data-driven decisions, it is important to understand the impact of your users' interactions and in-app flows on your growth goals and feature adoption.
- [Page Tracking](https://docs.userpilot.com/data-events/page-tracking/pages-dashboard.md): Tagging Pages enables you to monitor the page views within your application, allowing you to keep track of how many users are accessing each page and use this.
- [Select The Right Element](https://docs.userpilot.com/data-events/select-eleme-events.md): Detecting the right element in Userpilot is crucial for providing a personalized user experience through product tours, tooltips, and flow steps.
- [Custom Events](https://docs.userpilot.com/data-events/tracked-events/custom-events.md): Custom Events enable you to group multiple events into a single category, providing more accurate and comprehensive analytics.
- [Tracked Events](https://docs.userpilot.com/data-events/tracked-events/tracked-events.md): Sending tracked events and passing them to Userpilot is an easy and straightforward approach by calling the tracking method.
- [Event Schema](https://docs.userpilot.com/data-sync/event-schema.md): The event schema is the structure of the data that is exported from Userpilot Data Sync.
- [Frequently Asked Questions](https://docs.userpilot.com/data-sync/faq.md): Userpilot Data Sync is an add-on feature and may have an associated cost depending on your Userpilot subscription plan.
- [Data sync overview](https://docs.userpilot.com/data-sync/overview.md): Userpilot Data Sync is designed to provide you with direct, granular access to your raw event data, empowering you to integrate Userpilot insights seamlessly into your broader data strategy.
- [Prerequisites](https://docs.userpilot.com/data-sync/prerequisites.md): Before you can begin leveraging the powerful capabilities of Userpilot Data Sync, it’s essential to ensure that a few prerequisites are met. This section outlines the necessary account requirements, destination storage setup, and technical considerations to ensure a smooth and successful Data Sync i…
- [Setup and configuration](https://docs.userpilot.com/data-sync/setup-and-configuration.md): This section provides a comprehensive, step-by-step guide to help you begin using the Data Sync feature.
- [Troubleshooting](https://docs.userpilot.com/data-sync/troubleshooting.md): This section provides solutions to common issues that may arise when using Userpilot Data Sync.
- [Understanding Your Data](https://docs.userpilot.com/data-sync/understand-data.md): Once Userpilot Data Sync is active and data is flowing into your storage destination, the next step is to understand its structure and content. This knowledge is crucial for effectively ingesting, processing, and analyzing the data to extract meaningful insights. This section covers the typical file…
- [Custom Domain Hosting](https://docs.userpilot.com/developer/custom-domain.md): Host the Userpilot JavaScript SDK under your own domain to bypass ad blockers and internal restrictions on third-party domains.
- [Identify vs Reload](https://docs.userpilot.com/developer/identify-vs-reload.md): Understand the difference between userpilot.identify and userpilot.reload, and when to use each.
- [JavaScript SDK](https://docs.userpilot.com/developer/installation/SDK-APIs.md): The Userpilot JavaScript SDK allows you to identify users, track events, trigger content, and manage sessions directly from your web application.
- [Anonymous Users](https://docs.userpilot.com/developer/installation/anonymous-user.md): To display Userpilot content to users who aren't logged in or are browsing your public website anonymously, you can utilize the function.
- [Install Userpilot Mobile SDK](https://docs.userpilot.com/developer/installation/mobile/overview.md): Integrate the Userpilot Mobile SDK into your mobile application to enable in-app experiences and analytics.
- [Production and Staging Evironments](https://docs.userpilot.com/developer/installation/production-staging.md): Our new Staging environment will allow you to test Userpilot content in separately from your Production environment.
- [Self-hosting the SDK](https://docs.userpilot.com/developer/installation/self-host.md): The Userpilot SDK is the Javascript that runs in your web application and allows us to trigger Userpilot content, capture user feedback and collect analytical.
- [Web Installation](https://docs.userpilot.com/developer/installation/web.md): Install Userpilot on your web application using JavaScript snippet, Segment integration, or Google Tag Manager with step-by-step instructions.
- [Content Security Policy (CSP)](https://docs.userpilot.com/developer/security/csp.md): Userpilot sends data using a web-socket connection. This issue is most likely due to blockage caused by a content security policy(CSP) – some networks block.
- [Subresource Integrity (SRI)](https://docs.userpilot.com/developer/security/sri.md): When integrating the Userpilot SDK into your application, one important consideration is ensuring the security and integrity of the code you load from external sources. This is where Subresource Integrity (SRI) comes in.
- [Userpilot Installation Quickstart](https://docs.userpilot.com/getting-started/quickstart.md): Quick installation of Userpilot, user and event tracking setup, environment configuration, and security best practices.
- [What does Userpilot offer?](https://docs.userpilot.com/getting-started/what-does-userpilot-offer.md): Userpilot is a no-code product growth platform designed to help companies enhance user onboarding, drive feature adoption, and increase customer retention. It enables teams to create personalized in-app experiences without relying on engineering resources.
- [What is Userpilot?](https://docs.userpilot.com/getting-started/what-is-userpilot.md): Userpilot is a product growth platform that empowers non-technical teams to create and optimize user onboarding, drive feature adoption, and boost customer retention, without writing a single line of code.
- [Create Banner](https://docs.userpilot.com/in-app-engagement/banners/create-banner.md): Banners are floating messages that appear at the top or bottom of your web app, making it easy to highlight important updates without disrupting the user's.
- [Targeting a Banner](https://docs.userpilot.com/in-app-engagement/banners/targeting.md): Targeting Banners allows you to control where and to whom your Banner appears, ensuring it reaches the right audience at the right time.
- [Checklist Overview and Analytics](https://docs.userpilot.com/in-app-engagement/checklists/ChecklistOverviewandAnalytics.md): The overview tab provides general analytics for all of your checklists, allowing you to monitor live performance and determine the effectiveness of your.
- [Create a Checklist](https://docs.userpilot.com/in-app-engagement/checklists/create-checklist.md): Checklists are increasingly becoming a vital tool for guiding new users toward successful activation. They serve as a structured roadmap, ensuring that users.
- [Localization](https://docs.userpilot.com/in-app-engagement/checklists/localization.md): Userpilot's translation service gives you the full ability to translate the Checklist content into different languages.
- [Getting Started with Checklists](https://docs.userpilot.com/in-app-engagement/checklists/overview.md): Checklists are increasingly becoming a vital tool for guiding new users toward successful activation. They serve as a structured roadmap, ensuring that users.
- [Style Checklist Widget](https://docs.userpilot.com/in-app-engagement/checklists/style.md): To pick out a Theme for your Checklist, go to Style. You can pick out either a Light or Dark Theme. You also have the option to create your theme.
- [Targeting a Checklist](https://docs.userpilot.com/in-app-engagement/checklists/targeting-checklist.md): When you’re finished designing your Beacon, you can move on to Page Settings. Page Settings let you choose where you want your checklist to be triggered.
- [Testing and Publishing Checklists](https://docs.userpilot.com/in-app-engagement/checklists/test-and-publish.md): Previewing the Checklist during the building process is a great way to ensure it will look and behave as expected for your end-users.
- [Trigger and Beacon Settings](https://docs.userpilot.com/in-app-engagement/checklists/trigger-and-beacon-settings.md): Leverage the use of the Checklist by triggering it in the right place, and at the right time.
- [Add email addresses](https://docs.userpilot.com/in-app-engagement/emails/add-email-addresses.md): Specify the email addresses you wish to use for communicating with your users outside of your application.
- [Customize email signature](https://docs.userpilot.com/in-app-engagement/emails/customize-email-signature.md): Each user can create one email signature per added email address, and it will always appear at the bottom of the email.
- [Design email theme](https://docs.userpilot.com/in-app-engagement/emails/design-email-theme.md): Userpilot makes it easy to customize your email theme to align seamlessly with your brand identity. You can configure colors, fonts, button styles, and other.
- [Email performance analytics](https://docs.userpilot.com/in-app-engagement/emails/email-performance-analytics.md): Userpilot's Email Analytics gives you a detailed, real-time view of how recipients interact with your email.
- [Get started with emails](https://docs.userpilot.com/in-app-engagement/emails/get-started-with-emails.md): Userpilot's Email feature helps you re-engage users, boost retention, and deliver behavior-based messages outside the product.
- [Manage email subscriptions](https://docs.userpilot.com/in-app-engagement/emails/manage-email-subscriptions.md): To ensure your emails reach the right users who are interested in specific types of communication, and to help reduce unsubscribe rates.
- [Setup and authenticate your email domain](https://docs.userpilot.com/in-app-engagement/emails/setup-and-authenticate-email-domain.md): Set up domain authentication so Userpilot can send emails from your own domain with high deliverability.
- [Suppression list](https://docs.userpilot.com/in-app-engagement/emails/suppression-list.md): The Suppression List helps you maintain email deliverability, protect your sender reputation, and ensure compliance with regulations such as CAN-SPAM and GDPR.
- [Userpilot's Email Sending Guidelines](https://docs.userpilot.com/in-app-engagement/emails/userpilots-email-sending-guidelines.md): Guidelines for responsible email sending in Userpilot: permission-based practices, domain/IP warm-up, spam and bounce thresholds, unsubscribe and subscription topics, and enforcement steps.
- [Email deliverability performance metrics](https://docs.userpilot.com/in-app-engagement/emails/view-and-analyze-domain-level-performance.md): The Analytics page helps you measure how your emails perform across all authenticated sending domains.
- [Progressive Groups](https://docs.userpilot.com/in-app-engagement/flows/CE/groups.md): Use Progressive Groups to create flexible in-app flows that let users navigate steps freely, skip sections, and continue at their own pace.
- [Localize Flows](https://docs.userpilot.com/in-app-engagement/flows/CE/localize.md): Localize your Userpilot flows into multiple languages with one click, enabling global teams to deliver consistent, localized in-app experiences.
- [Flow Logic](https://docs.userpilot.com/in-app-engagement/flows/CE/logic.md): Use Flow Logic in Userpilot to create dynamic, personalized flows by conditionally skipping or routing users to steps based on their actions.
- [Page Changes](https://docs.userpilot.com/in-app-engagement/flows/CE/page-changes.md): Use Page Change steps to create multi-page Userpilot flows that guide users seamlessly across URLs without breaking their in-app experience.
- [Flow performance analytics](https://docs.userpilot.com/in-app-engagement/flows/getting-started/Flow-performance-analytics.md): Analyze how users engage with your flows using detailed flow and step-level metrics to identify drop-offs and optimize completion and adoption.
- [Best Practices](https://docs.userpilot.com/in-app-engagement/flows/getting-started/best-practices.md): Follow best practices to create effective Userpilot flows that improve usability, reduce friction, and drive higher user engagement and adoption.
- [Create a Flow](https://docs.userpilot.com/in-app-engagement/flows/getting-started/create-flow.md): Create guided in-app flows in Userpilot to onboard, educate, and engage users through tooltips, modals, slideouts, and driven actions.
- [Set up Flow Settings](https://docs.userpilot.com/in-app-engagement/flows/getting-started/flow-settings.md): Configure flow settings in Userpilot to control when, where, and how flows are triggered, ensuring personalized and relevant in-app experiences.
- [Testing Flows](https://docs.userpilot.com/in-app-engagement/flows/getting-started/testing-flows.md): Test Userpilot flows using Preview and Test modes to ensure correct behavior, accurate targeting, and a seamless end-user experience before launch.
- [Setup a Theme](https://docs.userpilot.com/in-app-engagement/flows/getting-started/themes.md): Set up and customize themes in Userpilot to control colors, fonts, and styles, ensuring your in-app experiences stay consistent and on-brand.
- [Experiments](https://docs.userpilot.com/in-app-engagement/flows/use-cases/AB-testing.md): Run A/B tests and multivariate experiments to measure the impact of flows on user behavior and optimize conversions.
- [Form Responses](https://docs.userpilot.com/in-app-engagement/flows/use-cases/forms.md): Collect structured user inputs directly inside Userpilot flows to capture feedback, data, and responses without additional coding or engineering effort.
- [Ordering & Throttling](https://docs.userpilot.com/in-app-engagement/flows/use-cases/order-throttle.md): After having multiple flows created, you probably want to control which flows should be seen first/last and how many are being seen by your users per page or.
- [Build a Mobile Slideout](https://docs.userpilot.com/in-app-engagement/mobile-content/build-a-mobile-slideout.md): Mobile Slideouts are single-step overlays that appear over part of your mobile apps screen. Unlike multi-screen Carousels that take over the entire display,.
- [Build a Mobile Carousel](https://docs.userpilot.com/in-app-engagement/mobile-content/build-mobile-carousel.md): Mobile Carousels are multi-screen flows you can use in a variety of ways. They’re perfect for onboarding new users, highlighting your app’s key features, or.
- [Get started with mobile content](https://docs.userpilot.com/in-app-engagement/mobile-content/get-started-with-mobile-content.md): Userpilot's Mobile Content feature lets you deliver in-app experiences natively on your mobile applications.
- [Mobile content ordering & throttling](https://docs.userpilot.com/in-app-engagement/mobile-content/mobile-content-ordering.md): In the ordering tab, you can prioritize your mobile content by placing it in a sequential order and control how often it appears using throttling, helping you decide which content is shown and when.
- [Mobile content overview](https://docs.userpilot.com/in-app-engagement/mobile-content/mobile-content-overview.md): The overview tab provides general analytics for all of your mobile content, allowing you to monitor live performance and determine the effectiveness of your.
- [Mobile content performance analytics](https://docs.userpilot.com/in-app-engagement/mobile-content/mobile-content-performance-analytics.md): Userpilot's mobile content analytics gives you a detailed, real-time view of how recipients interact with your mobile content.
- [Mobile Push Notifications](https://docs.userpilot.com/in-app-engagement/mobile-content/mobile-push-notifications.md): Mobile Push Notifications are a powerful way to proactively engage your app users outside the app. Use them to prompt action, deliver important updates, or.
- [Preparing to Send Push Notifications](https://docs.userpilot.com/in-app-engagement/mobile-content/preparing-to-send-push-notifications.md): Before you can start sending push notifications to your mobile app users through Userpilot, you’ll need to complete some one-time setup steps for both iOS and.
- [Create and Set up the Resource center](https://docs.userpilot.com/in-app-engagement/resource-center/create.md): The Userpilot Resource Center is a feature designed to provide your end-users with on-demand answers and contextual guidance directly within your application. This tool enhances user experience by offering in-app tutorials, seamless access to product news, and the ability for users to replay previou…
- [Knowledge Base Integrations](https://docs.userpilot.com/in-app-engagement/resource-center/knowledge-base-integrations.md): Userpilot's knowledge base integration allows you to provide users with contextual help directly within your application, allowing them to find your knowledge base articles and solutions without leaving your product.
- [Localize Resource Center Content](https://docs.userpilot.com/in-app-engagement/resource-center/localization.md): Userpilot's translation service gives you the full ability to translate Resource Center content in different languages. You can provide on-demand help for your users in the right language for them. This can be easily done with a click of a button.
- [Resource Center Overview](https://docs.userpilot.com/in-app-engagement/resource-center/overview.md): The Userpilot Resource Center is a feature designed to provide your end-users with on-demand answers and contextual guidance directly within your application.
- [Resource Center Style and Triggering](https://docs.userpilot.com/in-app-engagement/resource-center/style.md): Customize your Resource Center appearance including widget colors, fonts, beacon style, and configure search and triggering options.
- [Resource Center Targeting Settings](https://docs.userpilot.com/in-app-engagement/resource-center/targeting.md): The Resource Center targeting settings allow you to specify where to show the Resource Center based on the URL the user is currently on and who should see the module in the Resource Center.
- [Testing and Publishing Resource Center](https://docs.userpilot.com/in-app-engagement/resource-center/testing-publishing.md): Previewing the Resource Center while in the building process can be great to make sure that the Resource Center will look and behave with your end-users as expected.
- [Adding a Video to the Resource Center](https://docs.userpilot.com/in-app-engagement/resource-center/video-content.md): Learn how to add video content to your Userpilot Resource Center by embedding video scripts from YouTube, Vimeo, or Loom.
- [Zendesk Integration](https://docs.userpilot.com/in-app-engagement/resource-center/zendesk-integration.md): Integrating Zendesk with Userpilot will allow you to add your Zendesk knowledge base to your Resource Center.
- [Buttons](https://docs.userpilot.com/in-app-engagement/spotlights/buttons.md): The Buttons feature is a powerful tool designed to enhance user interactions within your platform. It allows you to strategically place actionable elements.
- [Hotspots](https://docs.userpilot.com/in-app-engagement/spotlights/hotspots.md): Hotspots are dynamic, flashing icons that appear on a selected element in your app until the user clicks or hovers over it.
- [Native Tooltips](https://docs.userpilot.com/in-app-engagement/spotlights/native-tooltips.md): Native Tooltips are interactive in-app messages that appear when users hover over or click on an element.
- [Overview](https://docs.userpilot.com/in-app-engagement/spotlights/overview.md): Spotlights are interactive in-app messages that appear within your web app. They provide a seamless way to boost user engagement by offering on-demand.
- [Spotlight Settings ](https://docs.userpilot.com/in-app-engagement/spotlights/targeting-settings.md): Targeting Spotlights allows you to control where and to whom your Spotlight appears, ensuring it reaches the right audience at the right time.
- [Amplitude Integration](https://docs.userpilot.com/integrations/amplitude.md): Send Userpilot events to Amplitude for deeper insights into user behavior and engagement.
- [Google Analytics Integration](https://docs.userpilot.com/integrations/google-analytics.md): Send Userpilot events to Google Analytics for deeper insights into user behavior and engagement.
- [Heap Integration](https://docs.userpilot.com/integrations/heap.md): Integrating Heap with Userpilot helps you deeply analyze Userpilot experiences' performance, health, and impact on your users.
- [HubSpot Integration](https://docs.userpilot.com/integrations/hubspot.md): Connect Userpilot with HubSpot to sync user properties, events, and activity data for enriched CRM records and automated workflows.
- [Intercom Integration](https://docs.userpilot.com/integrations/intercom.md): The Userpilot-Intercom integration allows you to send Userpilot event data directly to Intercom. This one-way integration helps you enhance customer support,.
- [Mixpanel Integration](https://docs.userpilot.com/integrations/mixpanel.md): Send Userpilot events to Mixpanel for deeper insights into user behavior and engagement.
- [Overview](https://docs.userpilot.com/integrations/overview.md): Integrations are simply links between Userpilot and other products in your stack. This link allows you to convert and send Userpilot flows and their associated data to a format compatible with other products and services.
- [Salesforce Integration](https://docs.userpilot.com/integrations/salesforce.md): Send Userpilot events to Salesforce for deeper insights into user behavior and engagement.
- [Segment Integration](https://docs.userpilot.com/integrations/segment.md): Integrate Userpilot with Segment to send Userpilot event data for analytics and automation
- [Adding Custom Objects in SalesForce](https://docs.userpilot.com/integrations/sf-custom-objects.md): Configure Userpilot custom objects in Salesforce to better view your Userpilot data
- [Slack Integration](https://docs.userpilot.com/integrations/slack.md): By integrating Userpilot with Slack, teams can act on user behavior, feedback, and product insights, all within their workspace.
- [Webhooks](https://docs.userpilot.com/integrations/webhooks.md): Webhooks (AKA callbacks) is a powerful tool to create a custom integration between Userpilot and your own app or third-party systems.
- [Global search](https://docs.userpilot.com/navigation-and-interface/global-search.md): The Global search in Userpilot lets you quickly find anything, from users and companies to flows, dashboards, and reports, all without leaving the page.
- [Inbox](https://docs.userpilot.com/navigation-and-interface/inbox.md): The Inbox is your central hub for all in-app notifications in Userpilot, helping you stay informed about what's happening across your account in one organized place.
- [Core Feature Engagement](https://docs.userpilot.com/product-analytics/dashboards/core-feature.md): The Core Feature Engagement Dashboard measures usage trends, adoption rate and retention metrics for your product's most pivotal feature.
- [Custom Dashboards](https://docs.userpilot.com/product-analytics/dashboards/custom-dashboards.md): Build personalized analytics dashboards to track the metrics that matter most, with templates for trial conversion, feature engagement, and upgrades.
- [Product Usage](https://docs.userpilot.com/product-analytics/dashboards/product-usage.md): The Product Usage Dashboard gives you a comprehensive overview of how your users and companies are engaging with your product.
- [New User Activation](https://docs.userpilot.com/product-analytics/dashboards/user-activation.md): The New Users Activation Dashboard measures activation rate, pinpoints time to value, and identifies drop-offs from sign-up to achieving the ‘Value Moment’.
- [User Retention](https://docs.userpilot.com/product-analytics/dashboards/user-retention.md): Track user retention over daily, weekly, and monthly intervals to understand engagement longevity and identify drop-off patterns.
- [Funnels](https://docs.userpilot.com/product-analytics/reports/funnels.md): Visualize and analyze how users move through key steps, identify drop-off points, and measure conversion rates to optimize user journeys.
- [Paths](https://docs.userpilot.com/product-analytics/reports/paths.md): Map the sequence of user actions before or after key events to understand navigation patterns, entry points, and drop-off behaviors.
- [Retention](https://docs.userpilot.com/product-analytics/reports/retention.md): Measure user engagement over time by tracking how often users return after completing key actions to identify product stickiness and adoption trends.
- [Trends](https://docs.userpilot.com/product-analytics/reports/trends.md): Trends in Userpilot is a powerful and flexible tool that helps you visualize patterns and compositions within your product data.
- [Session Replay](https://docs.userpilot.com/sessions/session-replay.md): Record and replay user sessions to analyze user journeys, identify friction points, troubleshoot issues, and make data-driven product improvements.
- [Create an NPS](https://docs.userpilot.com/user-feedback/nps/create-nps.md): Create and launch Net Promoter Score (NPS) surveys in Userpilot to measure customer loyalty, identify promoters and detractors, and track sentiment over time.
- [NPS Responses and Analytics](https://docs.userpilot.com/user-feedback/nps/nps-responses.md): Analyze NPS responses in Userpilot to understand customer sentiment, track loyalty trends, and take action based on promoters, passives, and detractors.
- [NPS Settings](https://docs.userpilot.com/user-feedback/nps/nps-settings.md): Configure NPS targeting, triggers, frequency, and localization in Userpilot to collect feedback from the right users at the right time.
- [Get started with survey](https://docs.userpilot.com/user-feedback/surveys/create-survey.md): Get started with Userpilot surveys to collect in-app feedback at the right moment, analyze responses, and turn user insights into action.
- [Survey details and analytics](https://docs.userpilot.com/user-feedback/surveys/survey-details-and-analytics.md): Analyze survey performance in Userpilot with detailed analytics to track responses, completion rates, and user engagement across segments and time.
- [User responses](https://docs.userpilot.com/user-feedback/surveys/user-responses.md): Review and analyze survey responses in Userpilot by user or by question to uncover patterns, track sentiment, and explore detailed feedback.
- [Users & Companies Dashboard](https://docs.userpilot.com/users-companies/dashboard.md): The Users and Companies Dashboards provide a centralised view of your application’s active users and the companies that they belong to. Here, you can view valuable information and insights at an individual user / company level - such as their associated properties and their product usage statistics.
- [Profiles](https://docs.userpilot.com/users-companies/profile.md): User & Company Profiles provide detailed insights into the individuals who are interacting with your platform. These individualised profiles help you understand user behaviour, segment users and companies effectively, and deliver personalised in-app experiences.
- [Segments](https://docs.userpilot.com/users-companies/segments.md): Segments allow you to group users and companies based on shared characteristics or behaviors. Throughout Userpilot, these segments enable you to refine user insights and deliver personalised in-app experiences.
- [Get started with Userpilot](https://docs.userpilot.com/welcome-to-userpilot/get-started-with-userpilot.md): This comprehensive guide outlines the essential steps to implement Userpilot successfully. We recommend prioritizing the actions below, as they enable access to core functionality and ensure your team is well-positioned to maximize the value of the platform.
- [Workflow performance analytics](https://docs.userpilot.com/workflow-performance-analytics.md): Workflow and Content analytics provide visibility into how users move through your workflows, helping you measure performance, identify drop-offs, and optimize outcomes. Here you can find high-level metrics and detailed user-level data so that you can understand engagement, completion, and goal achi…

## OpenAPI Specs

- [appex](https://docs.userpilot.com/api-references/appex.json)
- [analytex](https://docs.userpilot.com/api-references/analytex.json)
- [openapi](https://docs.userpilot.com/api-reference/openapi.json)