# Documentation - Formbricks

## Docs

- [Introduction](https://formbricks.com/docs/platform/introduction.md): Welcome to the Formbricks Documentation!
- [What is Formbricks?](https://formbricks.com/docs/platform/what-is-formbricks.md): Get to know Formbricks and its capabilities.
- [Open-Source](https://formbricks.com/docs/platform/open-source.md): Open-source Experience Management. Free & open source.
- [AI Features](https://formbricks.com/docs/platform/features/ai-features.md): How AI features are organized, hosted, and controlled in Formbricks.
- [Third-party Integrations](https://formbricks.com/docs/platform/features/integrations/overview.md): Configure third-party integrations with Formbricks Cloud.
- [Activepieces](https://formbricks.com/docs/platform/features/integrations/activepieces.md): A step-by-step guide to integrating Formbricks with Activepieces.
- [Airtable](https://formbricks.com/docs/platform/features/integrations/airtable.md): A step-by-step guide to integrate Airtable with Formbricks Cloud.
- [Google Sheets](https://formbricks.com/docs/platform/features/integrations/google-sheets.md): The Google Sheets integration allows you to automatically send responses to a Google Sheet of your choice.
- [HubSpot](https://formbricks.com/docs/platform/features/integrations/hubspot.md): Learn how to integrate Formbricks with HubSpot to automatically create or update contacts when survey responses are submitted.
- [Make](https://formbricks.com/docs/platform/features/integrations/make.md): Discover how to seamlessly integrate Formbricks with Make.com. Dive into our comprehensive guide to set up scenarios, connect with a plethora of apps, and send your survey data to more than 1000 platforms.
- [n8n](https://formbricks.com/docs/platform/features/integrations/n8n.md): Integrate Formbricks with n8n for a streamlined workflow experience.
- [Notion](https://formbricks.com/docs/platform/features/integrations/notion.md): The notion integration allows you to automatically send responses to a Notion database of your choice.
- [Slack](https://formbricks.com/docs/platform/features/integrations/slack.md): The slack integration allows you to automatically send responses to a Slack channel of your choice.
- [Wordpress](https://formbricks.com/docs/platform/features/integrations/wordpress.md): Target specific visitors with a survey on your WordPress page using Formbricks for free. Show survey on specific page or on button click.
- [Zapier](https://formbricks.com/docs/platform/features/integrations/zapier.md): Master the integration of Formbricks with Zapier using our detailed guide. Seamlessly connect your surveys to 5000+ apps, automate data transfers, and enhance feedback management. Start optimizing your workflow today.
- [Webhooks](https://formbricks.com/docs/platform/features/integrations/webhooks.md): With webhooks, you can receive real-time HTTP notifications when specific objects change in your Formbricks environment. This allows you to stay updated and trigger automated actions based on these events.
- [User Management Overview](https://formbricks.com/docs/platform/features/user-management.md): Manage organization members, roles, teams, and security settings to control access and collaboration in your Formbricks organization.
- [Organizations and roles](https://formbricks.com/docs/platform/features/user-management/organizations-and-roles.md): Understand organization-level roles and how they control access to teams, Workspaces, and data across your Formbricks organization.
- [Teams and roles](https://formbricks.com/docs/platform/features/user-management/teams-and-roles.md): Learn about team-level roles and workspace permissions that enable granular access control within teams and workspaces.
- [Invite members](https://formbricks.com/docs/platform/features/user-management/invite-members.md): Learn how to invite new members to your organization individually or in bulk, and manage invitation workflows.
- [Two-factor authentication](https://formbricks.com/docs/platform/features/user-management/two-factor-auth.md): Secure your account with an additional layer of protection using time-based codes from authenticator apps and backup codes.
- [Styling Theme](https://formbricks.com/docs/platform/features/styling-theme.md): Keep the survey styling consistent over all surveys with a Styling Theme. Customize colors, fonts, buttons, inputs, and more to match your brand.
- [Email Branding](https://formbricks.com/docs/platform/features/email-customization.md): Branding the emails that are sent to your respondents.
- [Surveys](https://formbricks.com/docs/surveys/overview.md): Design, distribute, and analyze surveys with Formbricks.
- [Add Image / Video](https://formbricks.com/docs/surveys/general-features/add-image-or-video-question.md): Enhance your questions by adding images or videos. This makes instructions clearer and the survey more engaging.
- [Conditional Logic](https://formbricks.com/docs/surveys/general-features/conditional-logic.md): Create complex survey logic with the Logic Editor. Use conditions, actions, and variables to create a personalized survey experience.
- [Custom Styling](https://formbricks.com/docs/surveys/general-features/overwrite-styling.md): Overwrite the global styling theme for individual surveys to create unique styles for each survey.
- [Hidden Fields](https://formbricks.com/docs/surveys/general-features/hidden-fields.md): Add data to a submission without asking the user to type it in. This feature is especially useful when you already have information about a user that you want to use in the analysis of the survey results (e.g. `payment plan` or `email`).
- [Limit Submissions](https://formbricks.com/docs/surveys/general-features/limit-submissions.md): Automatically close your survey after reaching a set number of responses in Formbricks. This is useful for limited offers, exclusive surveys, or when you need a specific sample size.
- [Multi-language Surveys](https://formbricks.com/docs/surveys/general-features/multi-language-surveys.md): Create surveys that support multiple languages using translations. This helps you reach a diverse audience without making separate surveys for each language. It also simplifies survey creation, delivery, and analysis for multilingual audiences.
- [Partial Submissions](https://formbricks.com/docs/surveys/general-features/partial-submissions.md): Capture and analyze partial submissions, providing detailed insights into how participants interact with each question within your survey. This feature is crucial for identifying specific points where respondents may disengage, allowing you to understand and address drop-offs effectively.
- [Recall Data](https://formbricks.com/docs/surveys/general-features/recall.md): Personalize your surveys by dynamically inserting data from URL parameters or previous answers into questions and descriptions. The Recall Data feature helps create engaging, adaptive survey experiences tailored to each respondent.
- [User Metadata](https://formbricks.com/docs/surveys/general-features/metadata.md): Formbricks captures metadata of your users for you when they fill a survey. This metadata is useful for understanding the context in which the user filled the survey. For example, if you are running a marketing campaign, you can understand which source is driving the most responses. Or if you are ru…
- [Variables](https://formbricks.com/docs/surveys/general-features/variables.md): Variables are a powerful feature in Formbricks that allows you to keep track of data variables when user fills a form. This feature is especially useful when you want to use your survey as a quiz.
- [Hide Back Button](https://formbricks.com/docs/surveys/general-features/hide-back-button.md): Learn how to hide the back button in surveys.
- [Email Follow-ups](https://formbricks.com/docs/surveys/general-features/email-followups.md): Automatically send customized emails to respondents based on their survey responses or specific survey endings.
- [Quota Management](https://formbricks.com/docs/surveys/general-features/quota-management.md): Control response collection by setting limits on specific segments to ensure balanced and representative survey datasets.
- [Spam Protection](https://formbricks.com/docs/surveys/general-features/spam-protection.md): Enable spam protection for your surveys using Google reCAPTCHA v3.
- [Tags](https://formbricks.com/docs/surveys/general-features/tags.md): Organize and categorize survey responses to easily filter, analyze, and manage your data.
- [Validation Rules](https://formbricks.com/docs/surveys/general-features/validation-rules.md): Validation rules help you ensure that respondents provide data in the correct format and within expected constraints
- [Quickstart - Link Surveys](https://formbricks.com/docs/surveys/link-surveys/quickstart.md): Create your first link survey in under 5 minutes.
- [Data Prefilling](https://formbricks.com/docs/surveys/link-surveys/data-prefilling.md): URL Data Prefilling for Link Surveys in Formbricks
- [Embed Surveys](https://formbricks.com/docs/surveys/link-surveys/embed-surveys.md): Embed Formbricks surveys seamlessly into your website using an iframe & Email using code snippets.
- [Link Settings](https://formbricks.com/docs/surveys/link-surveys/link-settings.md): Customize link titles, descriptions, and preview images to make your survey links more engaging when shared on social media and other platforms.
- [Pretty URL](https://formbricks.com/docs/surveys/link-surveys/pretty-url.md): Create a custom, memorable URL for your survey instead of sharing a long auto-generated link.
- [Personal Links](https://formbricks.com/docs/surveys/link-surveys/personal-links.md): Personal Links enable you to generate unique survey links for individual contacts, allowing you to attribute responses directly to specific people and set expiry dates for better control over survey distribution.
- [Single-Use Links](https://formbricks.com/docs/surveys/link-surveys/single-use-links.md): Make sure that each respondent only replies once with single use links.
- [Source Tracking](https://formbricks.com/docs/surveys/link-surveys/source-tracking.md): Track the source of your users in an easy & compliant way!
- [Start At Specific Block](https://formbricks.com/docs/surveys/link-surveys/start-at-block.md): Start a survey at a specific block using the URL to skip earlier blocks.
- [Verify Email](https://formbricks.com/docs/surveys/link-surveys/verify-email-before-survey.md): Verify email before accessing surveys
- [Market Research Panel with Prolific](https://formbricks.com/docs/surveys/link-surveys/market-research-panel.md): Formbricks surveys can be integrated with Prolifics participant panel easily. This tutorial walks you through the steps on how to access a pool of over 200.000 participants for your research.
- [PIN Protected Surveys](https://formbricks.com/docs/surveys/link-surveys/pin-protected-surveys.md): Enhance the security and exclusivity of your surveys by requiring respondents to enter a secure 4 digit PIN to access your survey. Learn how to enable PIN protection and the benefits it offers.
- [Custom Head Scripts](https://formbricks.com/docs/surveys/link-surveys/custom-head-scripts.md): Add tracking pixels, analytics, or custom code to your link surveys for self-hosted instances.
- [Offline Support](https://formbricks.com/docs/surveys/link-surveys/offline-support.md): Allow respondents to complete link surveys even without an internet connection.
- [Quickstart - Web & App Surveys](https://formbricks.com/docs/surveys/website-app-surveys/quickstart.md): App surveys deliver 6–10x higher conversion rates compared to email surveys. If you are new to Formbricks, follow the steps in this guide to launch a survey in your web or mobile app (React Native) within 10–15 minutes.
- [Migrate to Workspace ID](https://formbricks.com/docs/surveys/website-app-surveys/workspace-id-migration.md): Learn why Environment IDs were deprecated, what still works today, and how to migrate your SDK setup to Workspace IDs.
- [Framework Guides](https://formbricks.com/docs/surveys/website-app-surveys/framework-guides.md): Easily add the Formbricks App Survey SDK to your app with guides for different frameworks.
- [Google Tag Manager](https://formbricks.com/docs/surveys/website-app-surveys/google-tag-manager.md): Deploy Formbricks surveys through GTM without modifying your website code.
- [Custom CSS](https://formbricks.com/docs/surveys/website-app-surveys/custom-css.md): Use scoped global CSS to customize Website & App Surveys without breaking your app styles.
- [Actions](https://formbricks.com/docs/surveys/website-app-surveys/actions.md): Actions are predefined events within your app that prompt Formbricks to display a survey when triggered. These are detected by the Formbricks widget, which then presents the appropriate survey based on your predefined settings.
- [User Identification](https://formbricks.com/docs/surveys/website-app-surveys/user-identification.md): User Identification helps you to not only segment your users but also to see more information about the user who responded to a survey. This helps you to target surveys to specific user segments and see more information about the user who responded to a survey.
- [Attribute-based Targeting](https://formbricks.com/docs/surveys/website-app-surveys/attribute-based-targeting.md): Attribute-based Targeting allows you to show surveys to a specific segment of your users. You can target surveys based on user attributes, device type, and more. This helps you get more relevant insights while keeping survey fatigue at a minimum. After the initial setup, you can target any segment w…
- [Recontact Options](https://formbricks.com/docs/surveys/website-app-surveys/recontact.md): Recontact Options control how often a single survey is shown to the same user, helping you balance effective feedback collection with a positive user experience by preventing survey fatigue.
- [Cooldown Period](https://formbricks.com/docs/surveys/website-app-surveys/cooldown-period.md): The Cooldown Period is a workspace-wide guard that limits how often a user sees any survey, preventing survey fatigue across all your App Surveys.
- [Survey Display Logic](https://formbricks.com/docs/surveys/website-app-surveys/survey-display-logic.md): How Formbricks decides whether to show an app survey to a user — from the simplest always-on setup to Recontact Options, the workspace Cooldown Period, segment targeting, and interaction-based segments.
- [Survey % of Users](https://formbricks.com/docs/surveys/website-app-surveys/show-survey-to-percent-of-users.md): Formbricks allows you to display surveys to only a percentage of your targeted users. This is helpful for surveying on public facing website.
- [Address](https://formbricks.com/docs/surveys/question-type/address.md): The Address question type allows respondents to input their address details, including multiple fields such as address lines, city, state, and country. You can configure the question by adding a title, an optional description, and toggling specific fields to be required.
- [Consent](https://formbricks.com/docs/surveys/question-type/consent.md): The Consent card is used to obtain user agreement regarding a product, service, or policy. It features a bold statement or question as the title, followed by a brief description. At the end of the card, users can confirm their consent by checking a checkbox to indicate their agreement.
- [Contact Info](https://formbricks.com/docs/surveys/question-type/contact-info.md): The Contact Info question type allows respondents to provide their basic contact information such as name, email, and phone number. You can customize the form with a title, an optional description, and control which fields to display and require.
- [Date](https://formbricks.com/docs/surveys/question-type/date.md): The Date question type allows respondents to provide a date, such as when they are available or when an event is scheduled. It features a title to guide the respondent on what date to enter, and an optional description to provide further details or context.
- [File Upload](https://formbricks.com/docs/surveys/question-type/file-upload.md): The File Upload question type allows respondents to upload files related to your survey, such as production documents or requirement specifications. It features a title to guide the user on what to upload and an optional description to provide additional context.
- [Free Text](https://formbricks.com/docs/surveys/question-type/free-text.md): Free text questions allow respondents to enter a custom answer.
- [Matrix](https://formbricks.com/docs/surveys/question-type/matrix.md): Matrix questions allow respondents to select a value for each option presented in rows.
- [Net Promoter Score](https://formbricks.com/docs/surveys/question-type/net-promoter-score.md): Net Promoter Score questions allow respondents to rate a question on a scale from 0 to 10. Displays a title and a list of radio buttons for the respondent to choose from.
- [Ranking](https://formbricks.com/docs/surveys/question-type/ranking.md): Ranking questions let respondents select options in order from 1 to the total number of options. As they make their choices, the list is automatically rearranged in numerical order.
- [Rating](https://formbricks.com/docs/surveys/question-type/rating.md): Rating questions allow respondents to rate questions on a scale
- [Schedule A Meeting](https://formbricks.com/docs/surveys/question-type/schedule-a-meeting.md): The Schedule A Meeting question type allows respondents to book a meeting by selecting a date and time. It includes a title to guide the respondent, along with an optional description to provide additional context for the meeting setup.
- [Multi Select](https://formbricks.com/docs/surveys/question-type/select-multiple.md): Multi select questions allow respondents to select several answers from a list
- [Picture Selection](https://formbricks.com/docs/surveys/question-type/select-picture.md): Picture selection questions allow respondents to select one or more images from a list
- [Single Select](https://formbricks.com/docs/surveys/question-type/select-single.md): Single select questions allow respondents to select one answer from a list
- [Statement (Call to Action)](https://formbricks.com/docs/surveys/question-type/statement-cta.md): The Statement question type allows you to display descriptive information in your survey, such as a message or instruction.
- [Thank You Card](https://formbricks.com/docs/surveys/question-type/thank-you-card.md): The Thank You card is the last screen respondents see. Close the loop with a message, send them onwards with a button, or redirect them to another page.
- [Understanding Formbricks Survey Types](https://formbricks.com/docs/surveys/best-practices/understanding-survey-types.md): This guide explains the differences between Formbricks Link Surveys and Website & App Surveys to help you choose the right option.
- [Contact form](https://formbricks.com/docs/surveys/best-practices/contact-form.md): A step-by-step guide to creating a contact form using Formbricks.
- [Headless Surveys](https://formbricks.com/docs/surveys/best-practices/headless-surveys.md): Using Formbricks as a Headless Survey Platform
- [Docs Feedback](https://formbricks.com/docs/surveys/best-practices/docs-feedback.md): A step-by-step guide to getting feedback on your Documentation with Formbricks
- [Feature Chaser](https://formbricks.com/docs/surveys/best-practices/feature-chaser.md): Learn how to harness the power of Formbricks to gather targeted user feedback on specific features. Dive deep into creating, triggering, and publishing the Feature Chaser survey to enhance your product with actionable insights for specific users.
- [Feedback Box](https://formbricks.com/docs/surveys/best-practices/feedback-box.md): A step-by-step guide to creating a feedback box using Formbricks.
- [Improve Email Content](https://formbricks.com/docs/surveys/best-practices/improve-email-content.md): Measure email content quality with Formbricks
- [App Interview Prompt](https://formbricks.com/docs/surveys/best-practices/interview-prompt.md): Maximize User Interview Participation with App Interview Prompts
- [Learn from Churn](https://formbricks.com/docs/surveys/best-practices/cancel-subscription.md): Mastering Churn Surveys with Formbricks | Essential Tips & Steps
- [Product-Market Fit](https://formbricks.com/docs/surveys/best-practices/pmf-survey.md): How to Set Up a Product-Market Fit Survey Using Formbricks - Step-by-Step Guide
- [Quiz Time](https://formbricks.com/docs/surveys/best-practices/quiz-time.md): How to Create a Quiz Using Formbricks - Step-by-Step Guide
- [Improve Trial Conversion](https://formbricks.com/docs/surveys/best-practices/improve-trial-cr.md): Improve Trial Conversion with Formbricks
- [Panel Management](https://formbricks.com/docs/surveys/best-practices/research-panel.md): Build and manage your own research panel using Formbricks to collect profiling data, create targeted segments, and distribute personalized survey links to panel members.
- [Collect Google Reviews](https://formbricks.com/docs/surveys/best-practices/google-reviews.md): A step-by-step guide to asking for feedback and turning it into public Google reviews with Formbricks.
- [Unify Feedback](https://formbricks.com/docs/unify-feedback/overview.md): Bring feedback from any source to Formbricks and turn it into insights.
- [Feedback Datasets](https://formbricks.com/docs/unify-feedback/feedback-datasets.md): Org-level containers that group related Feedback Records and their sources.
- [Feedback Sources](https://formbricks.com/docs/unify-feedback/feedback-sources.md): Sources that bring feedback data into a Feedback Dataset.
- [Feedback Records](https://formbricks.com/docs/unify-feedback/feedback-records.md): The normalized unit of feedback inside a Feedback Dataset.
- [Enrichment](https://formbricks.com/docs/unify-feedback/enrichment.md): AI enrichment that adds sentiment, emotions, and a consolidated language to open-text Feedback Records.
- [Dashboards & Charts](https://formbricks.com/docs/unify-feedback/dashboards-charts.md): Visualize Feedback Records and group charts onto shareable dashboards.
- [Topics & Subtopics (Preview)](https://formbricks.com/docs/unify-feedback/topics-subtopics.md): Vector clustering of open-text feedback into Topics and Subtopics.
- [Map Feedback to Journeys, Not Touchpoints](https://formbricks.com/docs/unify-feedback/journey-management/map-feedback-to-journeys.md): Tag feedback by journey and stage so it rolls up to end-to-end journeys instead of scattered screens.
- [Build Journey Performance Scorecards](https://formbricks.com/docs/unify-feedback/journey-management/journey-scorecards.md): Turn journey-tagged feedback into one health score per journey using Unify Feedback dashboards.
- [Capture Detection Signals at the Moments That Matter](https://formbricks.com/docs/unify-feedback/journey-management/detection-signals.md): Collect feedback at the few journey steps that decide retention, and route it in as a detection signal to act on.
- [Surface Recurring Patterns with Topics](https://formbricks.com/docs/unify-feedback/journey-management/recurring-patterns.md): Cluster open-text feedback by journey into a pattern register the outer loop can fix at the root.
- [Close the Loop and Assign Journey Owners](https://formbricks.com/docs/unify-feedback/journey-management/close-the-loop.md): Route journey signals to a journey owner, track each case to recovery, and keep journeys owned over time.
- [Formbricks Hub](https://formbricks.com/docs/unify-feedback/formbricks-hub.md): The data layer that powers Unify Feedback.
- [Workflows](https://formbricks.com/docs/workflows/overview.md): Automate response-driven tasks in Formbricks with triggers, filters, actions, and observable runs.
- [Build a workflow](https://formbricks.com/docs/workflows/build.md): Choose and configure a workflow trigger and action, check the workflow, and enable it.
- [Manage and monitor workflows](https://formbricks.com/docs/workflows/manage-and-monitor.md): Manage workflow statuses, duplicate or delete workflows, and inspect runs and step logs.
- [Self-Hosting](https://formbricks.com/docs/self-hosting/overview.md): Learn how to self-host Formbricks.
- [One-Click Setup](https://formbricks.com/docs/self-hosting/setup/one-click.md): How to set up Formbricks instance with a one-click script
- [Docker Setup](https://formbricks.com/docs/self-hosting/setup/docker.md): Set up Formbricks quickly using our ready-to-use Docker image.
- [Monitoring](https://formbricks.com/docs/self-hosting/setup/monitoring.md): Monitoring your Formbricks installation for optimal performance.
- [Cluster Setup](https://formbricks.com/docs/self-hosting/setup/cluster-setup.md): Run Formbricks in a high-availability cluster.
- [Kubernetes Deployment](https://formbricks.com/docs/self-hosting/setup/kubernetes.md): Deploy Formbricks on Kubernetes with the current OCI Helm chart.
- [Custom SSL Certificate](https://formbricks.com/docs/self-hosting/configuration/custom-ssl.md): Using Formbricks One-Click Setup with a Custom SSL Certificate.
- [Environment Variables](https://formbricks.com/docs/self-hosting/configuration/environment-variables.md): Environment variables for Formbricks
- [Job Runner](https://formbricks.com/docs/self-hosting/configuration/job-runner.md): Configure and operate the BullMQ background-job worker in self-hosted Formbricks
- [SMTP Configuration](https://formbricks.com/docs/self-hosting/configuration/smtp.md): Set up email functionality for your self-hosted Formbricks instance
- [File Uploads Configuration](https://formbricks.com/docs/self-hosting/configuration/file-uploads.md): Configure file storage for survey images, file uploads, and Workspace assets in your self-hosted Formbricks instance
- [Domain Configuration](https://formbricks.com/docs/self-hosting/configuration/domain-configuration.md): Configuring your domain for Formbricks.
- [CDN](https://formbricks.com/docs/self-hosting/configuration/cdn.md): Use a CDN in front of public Formbricks traffic without serving stale survey assets after upgrades.
- [Custom Subpath](https://formbricks.com/docs/self-hosting/configuration/custom-subpath.md): Serve Formbricks from a custom URL prefix when you cannot expose it on the root domain.
- [Authentication Behavior](https://formbricks.com/docs/self-hosting/auth-behavior.md): Learn how authentication and user invitation work in self-hosted Formbricks deployments.
- [Open ID Connect](https://formbricks.com/docs/self-hosting/configuration/auth-sso/open-id-connect.md): Configure Open ID Connect for secure Single Sign-On with your Formbricks instance. Implement enterprise-grade authentication for your survey platform with Open ID Connect.
- [Keycloak OIDC](https://formbricks.com/docs/self-hosting/configuration/auth-sso/keycloak-oidc.md): Configure Keycloak as an OpenID Connect (OIDC) provider for secure Single Sign-On with your self-hosted Formbricks instance.
- [Azure AD OAuth](https://formbricks.com/docs/self-hosting/configuration/auth-sso/azure-ad-oauth.md): Configure Microsoft Entra ID (Azure AD) OAuth for secure Single Sign-On with your Formbricks instance. Use enterprise-grade authentication for your survey platform.
- [Google OAuth](https://formbricks.com/docs/self-hosting/configuration/auth-sso/google-oauth.md): Configure Google OAuth for secure Single Sign-On with your Formbricks instance. Implement enterprise-grade authentication for your survey platform with Google credentials.
- [SAML SSO](https://formbricks.com/docs/self-hosting/configuration/auth-sso/saml-sso.md): Configure SAML Single Sign-On (SSO) for secure enterprise authentication with your Formbricks instance.
- [Airtable (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/airtable.md): Instantly populate your Airtable table with survey data
- [Google Sheets (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/google-sheets.md): Instantly populate your Google Sheet table with survey data
- [n8n (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/n8n.md): Set up automations with your self-hosted n8n instance.
- [Notion (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/notion.md): Instantly populate a Notion database with survey data
- [Slack (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/slack.md): Send survey responses automatically to Slack workspace.
- [Zapier (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/zapier.md): Set up automations with your self-hosted Zapier instance.
- [ActivePieces (On Premise)](https://formbricks.com/docs/self-hosting/configuration/integrations/activepieces.md): Learn how to configure ActivePieces integration in your survey for self-hosting instance.
- [Migration](https://formbricks.com/docs/self-hosting/advanced/migration.md): Formbricks Self-hosted version migration
- [License](https://formbricks.com/docs/self-hosting/advanced/license.md): License for Formbricks
- [License Activation](https://formbricks.com/docs/self-hosting/advanced/license-activation.md): How to activate your Formbricks Enterprise License
- [Hide 'Powered by Formbricks' signature](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/hide-powered-by-formbricks.md): Hide our brand signature for a more white-labeled experience.
- [White-label Follow-ups](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/whitelabel-email-follow-ups.md): Add you own logo to emails sent to respondents
- [Teams & Roles (RBAC)](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/team-access.md): Granularly control which users have access to specific Workspaces and surveys.
- [Contact management & segments](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/contact-management-segments.md): Create and manage contacts and attribute-based segments with Formbricks.
- [OAuth & SSO](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/oidc-sso.md): Configure Single Sign-On with your Formbricks instance.
- [SAML SSO](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/saml-sso.md): Configure Single Sign-On with SAML for your Formbricks instance.
- [Audit Logging](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/audit-logging.md): Enable comprehensive audit logs for your Formbricks instance.
- [Unify Feedback](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/unify-feedback.md): Consolidate feedback from surveys, CSVs, and APIs into one normalized store.
- [Dashboards & Charts](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/dashboards.md): Visualize Feedback Records with charts and group them onto shareable dashboards.
- [AI Features](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/ai-features.md): Enable AI-powered helpers like survey translation and AI chart creation.
- [Workflows](https://formbricks.com/docs/self-hosting/advanced/enterprise-features/workflows.md): Automate response-driven tasks with triggers, filters, and actions.
- [Rate Limiting](https://formbricks.com/docs/self-hosting/advanced/rate-limiting.md): Current request rate limits in Formbricks
- [Overview](https://formbricks.com/docs/development/overview.md): Learn how to setup formbricks locally and build custom integrations and services.
- [Linux](https://formbricks.com/docs/development/local-setup/linux.md): How to set up Formbricks on a Linux machine
- [Mac](https://formbricks.com/docs/development/local-setup/mac.md): How to set up Formbricks on a Mac machine
- [Windows](https://formbricks.com/docs/development/local-setup/windows.md): How to set up Formbricks on a Windows machine
- [Gitpod](https://formbricks.com/docs/development/local-setup/gitpod.md): How to set up Formbricks in a Gitpod workspace
- [GitHub Codespaces](https://formbricks.com/docs/development/local-setup/github-codespaces.md): How to set up Formbricks in a GitHub Codespaces environment
- [Solution Overview](https://formbricks.com/docs/development/technical-handbook/overview.md): High-level architecture and technical details of the Formbricks platform
- [API Gateway](https://formbricks.com/docs/development/technical-handbook/api-gateway.md): Gateway auth architecture for proxied service APIs
- [MCP Server](https://formbricks.com/docs/development/technical-handbook/mcp-server.md): Configure and use the Formbricks v3 Surveys and Workflows MCP server
- [Cube Tenant Isolation](https://formbricks.com/docs/development/technical-handbook/cube-tenant-isolation.md): Threat model and controls for XM analytics tenant isolation in Cube
- [Database Model](https://formbricks.com/docs/development/technical-handbook/database-model.md): Overview of the Formbricks database schema and relationships
- [Tenant Separation](https://formbricks.com/docs/development/technical-handbook/tenant-separation.md): How Formbricks handles tenant separation on Formbricks Cloud
- [File and Directory Org.](https://formbricks.com/docs/development/standards/organization/file-and-directory-organization.md): This document outlines the structure and organization of files and directories in the Formbricks codebase, providing guidelines for maintaining consistency and clarity across the repository.
- [Naming Conventions](https://formbricks.com/docs/development/standards/organization/naming-conventions.md): This section outlines the guidelines for naming conventions across the codebase, ensuring consistency and clarity.
- [Modules & Components](https://formbricks.com/docs/development/standards/organization/module-component-structure.md): In this document we outline the best practices for organizing modules and components across the codebase. Clear separation of concerns between modules (which encompass business logic and domain-specific functionality) and components (reusable UI elements and building blocks) promotes clarity, scalab…
- [Code Formatting](https://formbricks.com/docs/development/standards/practices/code-formatting.md): Standards for consistent code formatting across the Formbricks codebase
- [Documentation](https://formbricks.com/docs/development/standards/practices/documentation.md): Standards for documenting code and features in the Formbricks codebase
- [Error Handling](https://formbricks.com/docs/development/standards/practices/error-handling.md): Standards for handling errors across the Formbricks codebase
- [Language-Specific](https://formbricks.com/docs/development/standards/technical/language-specific-conventions.md): This document outlines the language-specific conventions for the Formbricks codebase, providing guidelines for writing code in TypeScript/JavaScript.
- [Framework Usage](https://formbricks.com/docs/development/standards/technical/framework-usage.md): Guidelines on how Formbricks utilizes Next.js, Tailwind CSS, and Prisma ORM for efficient development and performance.
- [Code Reviews](https://formbricks.com/docs/development/standards/qa/code-reviews.md): This document outlines our comprehensive code review process at Formbricks. We maintain high quality, consistency, and best practices within our codebase through this structured approach.
- [Testing Methodology](https://formbricks.com/docs/development/standards/qa/testing-methodology.md): How we test Formbricks to ensure reliability, performance, and high-quality code.
- [Contribute to Formbricks](https://formbricks.com/docs/development/contribution/contribution.md): How to contribute to Formbricks
- [Setup SAML with Identity Providers](https://formbricks.com/docs/development/guides/auth-and-provision/setup-saml-with-identity-providers.md): This guide explains the settings you need to use to configure SAML with your Identity Provider. Once configured, obtain an XML metadata file and use it to configure SAML in Formbricks.
- [Troubleshooting](https://formbricks.com/docs/development/support/troubleshooting.md): Here, you'll find help with common issues.
- [Connect AI Agents (MCP)](https://formbricks.com/docs/platform/mcp/overview.md): Let AI assistants like Claude and Codex read and manage your Formbricks surveys and feedback records through the Model Context Protocol (MCP), authorized securely with your own login.
- [Set Up Your MCP Client](https://formbricks.com/docs/platform/mcp/setup.md): Connect Claude Code, the Claude apps, or Codex to the Formbricks MCP server over OAuth — plus how to manage and revoke access.
- [REST API](https://formbricks.com/docs/api-reference/rest-api.md): Formbricks provides two APIs: the Public Client API for frontend survey interactions and the Management API for backend management tasks.
- [Generate API Key](https://formbricks.com/docs/api-reference/generate-key.md): Here is how you can generate an API key which gives you full access to the Formbricks Management API. Keep it safe!
- [Test API Key](https://formbricks.com/docs/api-reference/test-key.md): Here is how you can test your API key to make sure it is working.
- [Create Display](https://formbricks.com/docs/api-reference/client-api--display/create-display.md): Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get Workspace State](https://formbricks.com/docs/api-reference/client-api--environment/get-workspace-state.md): Retrieves the workspace state to be used in Formbricks SDKs. Note - Environments are deprecated. Use Workspace/workspaceId terminology. **Cache Behavior**: This endpoint uses server-side caching with a **5-minute TTL (Time To Live)**. Any changes to surveys, action classes, workspace settings, or ot…
- [Create Response](https://formbricks.com/docs/api-reference/client-api--response/create-response.md): Create a response for a survey and it's fields with the user's responses. The userId & meta here is optional. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Update Response](https://formbricks.com/docs/api-reference/client-api--response/update-response.md): Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Create or Identify User](https://formbricks.com/docs/api-reference/client-api--user/create-or-identify-user.md): Endpoint for creating or identifying a user within the specified workspace. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get All Action Classes](https://formbricks.com/docs/api-reference/management-api--action-class/get-all-action-classes.md): Fetches all the action classes available in the workspace
- [Create Action Class](https://formbricks.com/docs/api-reference/management-api--action-class/create-action-class.md): Create Action Class from the UI or from the API! You can read more about them [here](https://formbricks.com/docs/in-app-surveys/actions).
- [Get Action Class by ID](https://formbricks.com/docs/api-reference/management-api--action-class/get-action-class-by-id.md): Fetch an Action Class by it's ID
- [Delete Action Class](https://formbricks.com/docs/api-reference/management-api--action-class/delete-action-class.md): Deletes an existing action class
- [Get All Contact Attribute Keys](https://formbricks.com/docs/api-reference/management-api--contact-attribute-keys/get-all-contact-attribute-keys.md): Retrieve a list of all contact attribute keys defined in the current workspace
- [Get Contact Attribute Key by ID](https://formbricks.com/docs/api-reference/management-api--contact-attribute-keys/get-contact-attribute-key-by-id.md): Retrieve a specific contact attribute key by its ID. This returns detailed information about how a particular attribute is defined in your workspace.
- [Get All Contact Attributes](https://formbricks.com/docs/api-reference/management-api--contact-attributes/get-all-contact-attributes.md): Retrieve a list of all contact attributes in the current workspace
- [Get All Contacts](https://formbricks.com/docs/api-reference/management-api--contacts/get-all-contacts.md): Retrieve a list of all contacts for the current workspace
- [Get Contact by ID](https://formbricks.com/docs/api-reference/management-api--contacts/get-contact-by-id.md): Retrieve a specific contact by its ID
- [Me](https://formbricks.com/docs/api-reference/management-api--me/me.md): Fetches the product associated with the passed API key
- [Get Survey Responses](https://formbricks.com/docs/api-reference/management-api--response/get-survey-responses.md): Pass the surveyId as a Query Parameter & only fetch responses for a specific survey that you have access to.
- [Create Response](https://formbricks.com/docs/api-reference/management-api--response/create-response.md): Create a user response using the management API. This will trigger the response pipeline, including webhooks, integrations, follow-up emails, and other configured actions.
- [Get Response by ID](https://formbricks.com/docs/api-reference/management-api--response/get-response-by-id.md): Fetch the entire response object based on its ID
- [Update Response](https://formbricks.com/docs/api-reference/management-api--response/update-response.md): Update an existing user response with new data. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.
- [Delete Response](https://formbricks.com/docs/api-reference/management-api--response/delete-response.md): Delete a response with its ID
- [Upload Public File](https://formbricks.com/docs/api-reference/management-api--storage/upload-public-file.md): API endpoint for uploading public files. Uploaded files are public and accessible by anyone. This endpoint requires authentication and enforces a hard limit of 5 MB for all uploads. It accepts a JSON body with fileName, fileType, workspaceId, and optionally allowedFileExtensions to restrict file typ…
- [Get All Surveys](https://formbricks.com/docs/api-reference/management-api--survey/get-all-surveys.md): Fetches all existing surveys. Each survey includes both `questions` (the legacy structure) and `blocks` (the newer structure). `questions` is always derived from `blocks` for backwards compatibility, so integrations may read either field.
- [Create Survey](https://formbricks.com/docs/api-reference/management-api--survey/create-survey.md): Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We'd however recommend you to do this via our Formbricks App with the UI for a better visual experience.
- [Get Survey by ID](https://formbricks.com/docs/api-reference/management-api--survey/get-survey-by-id.md): Fetch a survey object based on its ID. The response includes both `questions` (the legacy structure) and `blocks` (the newer structure). `questions` is always derived from `blocks` for backwards compatibility, so integrations may read either field.
- [Update Survey](https://formbricks.com/docs/api-reference/management-api--survey/update-survey.md): Update an existing survey with new properties. This is also what we'd recommend you to do from the UI for a better visual feedback.
- [Delete Survey](https://formbricks.com/docs/api-reference/management-api--survey/delete-survey.md): Delete a Survey by its ID. Please use this only when extrememly necessary.
- [Get SingleUse Links](https://formbricks.com/docs/api-reference/management-api--survey/get-singleuse-links.md): Generates multiple single use survey links for a survey based on its id.
- [Get All Webhooks](https://formbricks.com/docs/api-reference/management-api--webhook/get-all-webhooks.md): Retrieve a list of all webhooks for the current workspace
- [Create Webhook](https://formbricks.com/docs/api-reference/management-api--webhook/create-webhook.md): Create a new webhook right from the API and see it active right away!
- [Get Webhook](https://formbricks.com/docs/api-reference/management-api--webhook/get-webhook.md): Get a specific webhook object based on its ID
- [Delete Webhook](https://formbricks.com/docs/api-reference/management-api--webhook/delete-webhook.md): Delete an existing webhook by provifding it's ID. It will immediately apply and not trigger again.
- [Health Check](https://formbricks.com/docs/api-reference/health/health-check.md): Formbricks' Health Check endpoint to make sure the App & the Database are connected with each other & up!
- [API v2 Reference (Beta)](https://formbricks.com/docs/api-v2-reference/introduction.md)
- [Update Response](https://formbricks.com/docs/api-v2-reference/client-api--response/update-response.md): Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Create Response](https://formbricks.com/docs/api-v2-reference/client-api--response/create-response.md): Create a response for a survey and its fields with the user's responses. The userId & meta here is optional. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Create Display](https://formbricks.com/docs/api-v2-reference/client-api--display/create-display.md): Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get Workspace State](https://formbricks.com/docs/api-v2-reference/client-api--workspace/get-workspace-state.md): Retrieves the Workspace state to be used in Formbricks SDKs. Note - Environments are deprecated. Use Workspace/workspaceId terminology. **Cache Behavior**: This endpoint uses server-side caching with a **5-minute TTL (Time To Live)**. Any changes to surveys, action classes, Workspace settings, or ot…
- [Create or Identify User](https://formbricks.com/docs/api-v2-reference/client-api--user/create-or-identify-user.md): Endpoint for creating or identifying a user within the specified Workspace. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Upload Private File](https://formbricks.com/docs/api-v2-reference/client-api--file-upload/upload-private-file.md): API endpoint for uploading private files. Uploaded files are kept private so that only users with access to the specified Workspace can retrieve them. The endpoint validates the survey ID, file name, and file type from the request body, and returns a signed URL for S3 uploads along with a local uplo…
- [Health Check](https://formbricks.com/docs/api-v2-reference/health/health-check.md): Check the health status of critical application dependencies including database and cache.
- [Get roles](https://formbricks.com/docs/api-v2-reference/roles/get-roles.md): Gets roles from the database.
- [Me](https://formbricks.com/docs/api-v2-reference/me/me.md): Fetches the Workspaces and organizations associated with the API key.
- [Get responses](https://formbricks.com/docs/api-v2-reference/management-api--responses/get-responses.md): Gets responses from the database.
- [Create a response](https://formbricks.com/docs/api-v2-reference/management-api--responses/create-a-response.md): Creates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails, and other configured actions.
- [Get a response](https://formbricks.com/docs/api-v2-reference/management-api--responses/get-a-response.md): Gets a response from the database.
- [Update a response](https://formbricks.com/docs/api-v2-reference/management-api--responses/update-a-response.md): Updates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.
- [Delete a response](https://formbricks.com/docs/api-v2-reference/management-api--responses/delete-a-response.md): Deletes a response from the database.
- [Upload Bulk Contacts](https://formbricks.com/docs/api-v2-reference/management-api--contacts/upload-bulk-contacts.md): Uploads contacts in bulk. This endpoint expects the bulk request shape: `contacts` must be an array, and each contact item must contain an `attributes` array of `{ attributeKey, value }` objects. Unlike `POST /management/contacts`, this endpoint does not accept a top-level `attributes` object. Each…
- [Create a contact](https://formbricks.com/docs/api-v2-reference/management-api--contacts/create-a-contact.md): Creates a single contact in the database. This endpoint expects a top-level `attributes` object. For bulk uploads, use `PUT /management/contacts/bulk`, which expects `contacts[].attributes[]` instead. Each contact must have a valid email address in the attributes. All attribute keys must already exi…
- [Get contact attribute keys](https://formbricks.com/docs/api-v2-reference/management-api--contact-attribute-keys/get-contact-attribute-keys.md): Gets contact attribute keys from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Create a contact attribute key](https://formbricks.com/docs/api-v2-reference/management-api--contact-attribute-keys/create-a-contact-attribute-key.md): Creates a contact attribute key in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get a contact attribute key](https://formbricks.com/docs/api-v2-reference/management-api--contact-attribute-keys/get-a-contact-attribute-key.md): Gets a contact attribute key from the database.
- [Update a contact attribute key](https://formbricks.com/docs/api-v2-reference/management-api--contact-attribute-keys/update-a-contact-attribute-key.md): Updates a contact attribute key in the database.
- [Delete a contact attribute key](https://formbricks.com/docs/api-v2-reference/management-api--contact-attribute-keys/delete-a-contact-attribute-key.md): Deletes a contact attribute key from the database.
- [Get personalized survey link for a contact](https://formbricks.com/docs/api-v2-reference/management-api--surveys--contact-links/get-personalized-survey-link-for-a-contact.md): Retrieves a personalized link for a specific survey.
- [Get survey links for contacts in a segment](https://formbricks.com/docs/api-v2-reference/management-api--surveys--contact-links/get-survey-links-for-contacts-in-a-segment.md): Generates personalized survey links for contacts in a segment.
- [Get webhooks](https://formbricks.com/docs/api-v2-reference/management-api--webhooks/get-webhooks.md): Gets webhooks from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Create a webhook](https://formbricks.com/docs/api-v2-reference/management-api--webhooks/create-a-webhook.md): Creates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get a webhook](https://formbricks.com/docs/api-v2-reference/management-api--webhooks/get-a-webhook.md): Gets a webhook from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Update a webhook](https://formbricks.com/docs/api-v2-reference/management-api--webhooks/update-a-webhook.md): Updates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Delete a webhook](https://formbricks.com/docs/api-v2-reference/management-api--webhooks/delete-a-webhook.md): Deletes a webhook from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- [Get teams](https://formbricks.com/docs/api-v2-reference/organizations-api--teams/get-teams.md): Gets teams from the database.
- [Create a team](https://formbricks.com/docs/api-v2-reference/organizations-api--teams/create-a-team.md): Creates a team in the database.
- [Get a team](https://formbricks.com/docs/api-v2-reference/organizations-api--teams/get-a-team.md): Gets a team from the database.
- [Update a team](https://formbricks.com/docs/api-v2-reference/organizations-api--teams/update-a-team.md): Updates a team in the database.
- [Delete a team](https://formbricks.com/docs/api-v2-reference/organizations-api--teams/delete-a-team.md): Deletes a team from the database.
- [Get Workspace teams](https://formbricks.com/docs/api-v2-reference/organizations-api--workspace-teams/get-workspace-teams.md): Gets workspace teams from the database.
- [Update a Workspace team](https://formbricks.com/docs/api-v2-reference/organizations-api--workspace-teams/update-a-workspace-team.md): Updates a Workspace team in the database.
- [Create a Workspace team](https://formbricks.com/docs/api-v2-reference/organizations-api--workspace-teams/create-a-workspace-team.md): Creates a Workspace team in the database.
- [Delete a Workspace team](https://formbricks.com/docs/api-v2-reference/organizations-api--workspace-teams/delete-a-workspace-team.md): Deletes a Workspace team from the database.
- [Get users](https://formbricks.com/docs/api-v2-reference/organizations-api--users/get-users.md): Gets users from the database.<br />Only available for self-hosted Formbricks.
- [Create a user](https://formbricks.com/docs/api-v2-reference/organizations-api--users/create-a-user.md): Create a new user in the database.<br />Only available for self-hosted Formbricks.
- [Update a user](https://formbricks.com/docs/api-v2-reference/organizations-api--users/update-a-user.md): Updates an existing user in the database.<br />Only available for self-hosted Formbricks.

## OpenAPI Specs

- [openapi](https://formbricks.com/docs/api-v3-reference/openapi.yml)