{ "$schema": "https://mintlify.com/docs.json", "colors": { "dark": "#00C4B8", "light": "#00C4B8", "primary": "#00C4B8" }, "errors": { "404": { "redirect": true } }, "favicon": "/images/favicon.svg", "footer": { "socials": { "github": "https://github.com/formbricks/formbricks", "linkedin": "https://linkedin.com/company/formbricks", "x": "https://x.com/formbricks" } }, "integrations": { "posthog": { "apiHost": "https://eu.i.posthog.com", "apiKey": "phc_zJO1n3rjHlhqKiJ0gqLDwT4qvfWF1wzHDq2gfl0moQm" } }, "logo": { "dark": "/images/logo-dark.svg", "light": "/images/logo-light.svg" }, "name": "Documentation - Formbricks", "navbar": { "links": [ { "href": "https://github.com/formbricks/formbricks/discussions", "label": "Support" } ], "primary": { "href": "https://app.formbricks.com", "label": "Go to app", "type": "button" } }, "navigation": { "tabs": [ { "groups": [ { "group": "Overview", "pages": ["overview/introduction", "overview/what-is-formbricks", "overview/open-source"] } ], "tab": "Overview" }, { "groups": [ { "group": "XM & Surveys", "pages": ["xm-and-surveys/overview"] }, { "group": "Surveys", "pages": [ { "group": "General Features", "icon": "wrench", "pages": [ "xm-and-surveys/surveys/general-features/add-image-or-video-question", "xm-and-surveys/surveys/general-features/conditional-logic", "xm-and-surveys/surveys/general-features/overwrite-styling", "xm-and-surveys/surveys/general-features/hidden-fields", "xm-and-surveys/surveys/general-features/limit-submissions", "xm-and-surveys/surveys/general-features/multi-language-surveys", "xm-and-surveys/surveys/general-features/partial-submissions", "xm-and-surveys/surveys/general-features/recall", "xm-and-surveys/surveys/general-features/metadata", "xm-and-surveys/surveys/general-features/variables", "xm-and-surveys/surveys/general-features/hide-back-button", "xm-and-surveys/surveys/general-features/email-followups", "xm-and-surveys/surveys/general-features/quota-management", "xm-and-surveys/surveys/general-features/spam-protection", "xm-and-surveys/surveys/general-features/tags" ] }, { "group": "Link Surveys", "icon": "link", "pages": [ "xm-and-surveys/surveys/link-surveys/quickstart", { "group": "Features", "icon": "wrench", "pages": [ "xm-and-surveys/surveys/link-surveys/data-prefilling", "xm-and-surveys/surveys/link-surveys/embed-surveys", "xm-and-surveys/surveys/link-surveys/link-settings", "xm-and-surveys/surveys/link-surveys/personal-links", "xm-and-surveys/surveys/link-surveys/single-use-links", "xm-and-surveys/surveys/link-surveys/source-tracking", "xm-and-surveys/surveys/link-surveys/start-at-question", "xm-and-surveys/surveys/link-surveys/verify-email-before-survey", "xm-and-surveys/surveys/link-surveys/market-research-panel", "xm-and-surveys/surveys/link-surveys/pin-protected-surveys" ] } ] }, { "group": "Website & App Surveys", "icon": "mobile", "pages": [ "xm-and-surveys/surveys/website-app-surveys/quickstart", "xm-and-surveys/surveys/website-app-surveys/framework-guides", "xm-and-surveys/surveys/website-app-surveys/google-tag-manager", { "group": "Features", "icon": "wrench", "pages": [ "xm-and-surveys/surveys/website-app-surveys/actions", "xm-and-surveys/surveys/website-app-surveys/advanced-targeting", "xm-and-surveys/surveys/website-app-surveys/user-identification", "xm-and-surveys/surveys/website-app-surveys/recontact", "xm-and-surveys/surveys/website-app-surveys/show-survey-to-percent-of-users" ] } ] }, { "group": "Question Types", "icon": "question", "pages": [ "xm-and-surveys/surveys/question-type/address", "xm-and-surveys/surveys/question-type/consent", "xm-and-surveys/surveys/question-type/contact-info", "xm-and-surveys/surveys/question-type/date", "xm-and-surveys/surveys/question-type/file-upload", "xm-and-surveys/surveys/question-type/free-text", "xm-and-surveys/surveys/question-type/matrix", "xm-and-surveys/surveys/question-type/net-promoter-score", "xm-and-surveys/surveys/question-type/ranking", "xm-and-surveys/surveys/question-type/rating", "xm-and-surveys/surveys/question-type/schedule-a-meeting", "xm-and-surveys/surveys/question-type/select-multiple", "xm-and-surveys/surveys/question-type/select-picture", "xm-and-surveys/surveys/question-type/select-single", "xm-and-surveys/surveys/question-type/statement-cta" ] } ] }, { "group": "Platform Features", "pages": [ { "group": "Integrations", "icon": "bridge", "pages": [ "xm-and-surveys/core-features/integrations/overview", "xm-and-surveys/core-features/integrations/activepieces", "xm-and-surveys/core-features/integrations/airtable", "xm-and-surveys/core-features/integrations/google-sheets", "xm-and-surveys/core-features/integrations/make", "xm-and-surveys/core-features/integrations/n8n", "xm-and-surveys/core-features/integrations/notion", "xm-and-surveys/core-features/integrations/slack", "xm-and-surveys/core-features/integrations/wordpress", "xm-and-surveys/core-features/integrations/zapier", "xm-and-surveys/core-features/integrations/webhooks" ] }, { "group": "User Management", "icon": "user", "pages": [ "xm-and-surveys/core-features/user-management", "xm-and-surveys/core-features/user-management/organizations-and-roles", "xm-and-surveys/core-features/user-management/teams-and-roles", "xm-and-surveys/core-features/user-management/invite-members", "xm-and-surveys/core-features/user-management/two-factor-auth" ] }, "xm-and-surveys/core-features/styling-theme", "xm-and-surveys/core-features/email-customization", "xm-and-surveys/core-features/test-environment" ] }, { "group": "XM", "pages": [ { "group": "Best Practices", "icon": "lightbulb", "pages": [ "xm-and-surveys/xm/best-practices/contact-form", "xm-and-surveys/xm/best-practices/headless-surveys", "xm-and-surveys/xm/best-practices/docs-feedback", "xm-and-surveys/xm/best-practices/feature-chaser", "xm-and-surveys/xm/best-practices/feedback-box", "xm-and-surveys/xm/best-practices/improve-email-content", "xm-and-surveys/xm/best-practices/interview-prompt", "xm-and-surveys/xm/best-practices/cancel-subscription", "xm-and-surveys/xm/best-practices/pmf-survey", "xm-and-surveys/xm/best-practices/quiz-time", "xm-and-surveys/xm/best-practices/improve-trial-cr" ] } ] } ], "tab": "XM & Surveys" }, { "groups": [ { "group": "Self Hosting", "pages": ["self-hosting/overview"] }, { "group": "Setup", "pages": [ "self-hosting/setup/one-click", "self-hosting/setup/docker", "self-hosting/setup/monitoring", "self-hosting/setup/cluster-setup", "self-hosting/setup/kubernetes" ] }, { "group": "Configuration", "pages": [ "self-hosting/configuration/custom-ssl", "self-hosting/configuration/environment-variables", "self-hosting/configuration/smtp", "self-hosting/configuration/file-uploads", "self-hosting/configuration/domain-configuration", "self-hosting/configuration/custom-subpath", { "group": "Auth & SSO", "icon": "lock", "pages": [ "self-hosting/auth-behavior", "self-hosting/configuration/auth-sso/open-id-connect", "self-hosting/configuration/auth-sso/azure-ad-oauth", "self-hosting/configuration/auth-sso/google-oauth", "self-hosting/configuration/auth-sso/saml-sso" ] }, { "group": "Integrations", "icon": "bridge", "pages": [ "self-hosting/configuration/integrations/airtable", "self-hosting/configuration/integrations/google-sheets", "self-hosting/configuration/integrations/n8n", "self-hosting/configuration/integrations/notion", "self-hosting/configuration/integrations/slack", "self-hosting/configuration/integrations/zapier", "self-hosting/configuration/integrations/activepieces" ] } ] }, { "group": "Advanced", "pages": [ "self-hosting/advanced/migration", "self-hosting/advanced/license", "self-hosting/advanced/license-activation", { "group": "Enterprise Features", "icon": "building", "pages": [ "self-hosting/advanced/enterprise-features/hide-powered-by-formbricks", "self-hosting/advanced/enterprise-features/whitelabel-email-follow-ups", "self-hosting/advanced/enterprise-features/team-access", "self-hosting/advanced/enterprise-features/contact-management-segments", "self-hosting/advanced/enterprise-features/multi-language-surveys", "self-hosting/advanced/enterprise-features/oidc-sso", "self-hosting/advanced/enterprise-features/saml-sso", "self-hosting/advanced/enterprise-features/audit-logging" ] }, "self-hosting/advanced/rate-limiting" ] } ], "tab": "Self Hosting" }, { "groups": [ { "group": "Development", "pages": ["development/overview"] }, { "group": "Local Setup", "pages": [ "development/local-setup/linux", "development/local-setup/mac", "development/local-setup/windows", "development/local-setup/gitpod", "development/local-setup/github-codespaces" ] }, { "group": "Technical Handbook", "pages": [ "development/technical-handbook/overview", "development/technical-handbook/database-model", "development/technical-handbook/tenant-separation" ] }, { "group": "Standards", "pages": [ { "group": "Code Organization", "icon": "code", "pages": [ "development/standards/organization/file-and-directory-organization", "development/standards/organization/naming-conventions", "development/standards/organization/module-component-structure" ] }, { "group": "Development Practices", "icon": "laptop", "pages": [ "development/standards/practices/code-formatting", "development/standards/practices/documentation", "development/standards/practices/error-handling" ] }, { "group": "Technical Standards", "icon": "gear", "pages": [ "development/standards/technical/language-specific-conventions", "development/standards/technical/framework-usage" ] }, { "group": "Quality Assurance", "icon": "shield", "pages": [ "development/standards/qa/code-reviews", "development/standards/qa/testing-methodology" ] } ] }, { "group": "Contributions", "pages": ["development/contribution/contribution"] }, { "group": "Guides", "pages": [ { "group": "Auth & Provision", "icon": "user-shield", "pages": ["development/guides/auth-and-provision/setup-saml-with-identity-providers"] } ] }, { "group": "Support", "pages": ["development/support/troubleshooting"] } ], "tab": "Development" }, { "groups": [ { "group": "API v1 Documentation", "pages": ["api-reference/rest-api", "api-reference/generate-key", "api-reference/test-key"] } ], "openapi": { "directory": "api-reference", "source": "/api-reference/openapi.json" }, "tab": "API v1 Reference" }, { "groups": [ { "group": "API v2 Documentation (Beta)", "pages": ["api-v2-reference/introduction"] } ], "openapi": { "directory": "api-v2-reference", "source": "/api-v2-reference/openapi.yml" }, "tab": "API v2 Reference (Beta)" } ] }, "redirects": [ { "destination": "/docs/overview/what-is-formbricks", "source": "/docs/introduction/what-is-formbricks" }, { "destination": "/docs/overview/open-source", "source": "/docs/introduction/why-open-source" }, { "destination": "/docs/xm-and-surveys/overview", "source": "/docs/introduction/how-it-works" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/contact-form", "source": "/docs/best-practices/contact-form" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/docs-feedback", "source": "/docs/best-practices/docs-feedback" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/feature-chaser", "source": "/docs/best-practices/feature-chaser" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/feedback-box", "source": "/docs/best-practices/feedback-box" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/improve-email-content", "source": "/docs/best-practices/improve-email-content" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/interview-prompt", "source": "/docs/best-practices/interview-prompt" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/cancel-subscription", "source": "/docs/best-practices/cancel-subscription" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/pmf-survey", "source": "/docs/best-practices/pmf-survey" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/quiz-time", "source": "/docs/best-practices/quiz-time" }, { "destination": "/docs/xm-and-surveys/xm/best-practices/improve-trial-cr", "source": "/docs/best-practices/improve-trial-cr" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/quickstart", "source": "/docs/link-surveys/quickstart" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/add-image-or-video-question", "source": "/docs/link-surveys/global/add-image-or-video-question" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/conditional-logic", "source": "/docs/link-surveys/global/conditional-logic" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/overwrite-styling", "source": "/docs/link-surveys/global/overwrite-styling" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/data-prefilling", "source": "/docs/link-surveys/global/data-prefilling" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/embed-surveys", "source": "/docs/link-surveys/embed-surveys" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/hidden-fields", "source": "/docs/link-surveys/global/hidden-fields" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/limit-submissions", "source": "/docs/link-surveys/global/limit-submissions" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/market-research-panel", "source": "/docs/link-surveys/market-research-panel" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/multi-language-surveys", "source": "/docs/link-surveys/global/multi-language-surveys" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/partial-submissions", "source": "/docs/link-surveys/global/partial-submissions" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/pin-protected-surveys", "source": "/docs/link-surveys/pin-protected-surveys" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/recall", "source": "/docs/link-surveys/global/recall" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/single-use-links", "source": "/docs/link-surveys/single-use-links" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/source-tracking", "source": "/docs/link-surveys/source-tracking" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/schedule-start-end-dates", "source": "/docs/link-surveys/global/schedule-start-end-dates" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/start-at-question", "source": "/docs/link-surveys/start-at-question" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/metadata", "source": "/docs/link-surveys/global/metadata" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/variables", "source": "/docs/link-surveys/global/variables" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/verify-email-before-survey", "source": "/docs/link-surveys/verify-email-before-survey" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/add-image-or-video-question", "source": "/docs/app-surveys/global/add-image-or-video-question" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/consent", "source": "/docs/core-features/global/question-type/consent" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/statement-cta", "source": "/docs/core-features/global/question-type/statement-cta" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/airtable", "source": "/docs/developer-docs/integrations/airtable" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/zapier", "source": "/docs/developer-docs/integrations/zapier" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/wordpress", "source": "/docs/developer-docs/integrations/wordpress" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/slack", "source": "/docs/developer-docs/integrations/slack" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/n8n", "source": "/docs/developer-docs/integrations/n8n" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/notion", "source": "/docs/developer-docs/integrations/notion" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/google-sheets", "source": "/docs/developer-docs/integrations/google-sheets" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/quickstart", "source": "/docs/app-surveys/quickstart" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/address", "source": "/docs/core-features/global/question-type/address" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides", "source": "/docs/app-surveys/framework-guides" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/activepieces", "source": "/docs/developer-docs/integrations/activepieces" }, { "destination": "/docs/xm-and-surveys/core-features/user-management", "source": "/docs/core-features/global/access-roles" }, { "destination": "/docs/xm-and-surveys/core-features/styling-theme", "source": "/docs/core-features/global/styling-theme" }, { "destination": "/docs/xm-and-surveys/core-features/email-customization", "source": "/docs/core-features/global/email-customization" }, { "destination": "/docs/self-hosting/setup/one-click", "source": "/docs/self-hosting/one-click" }, { "destination": "/docs/self-hosting/configuration/custom-ssl", "source": "/docs/self-hosting/custom-ssl" }, { "destination": "/docs/self-hosting/setup/docker", "source": "/docs/self-hosting/docker" }, { "destination": "/docs/self-hosting/setup/cluster-setup", "source": "/docs/self-hosting/cluster-setup" }, { "destination": "/docs/self-hosting/advanced/migration", "source": "/docs/self-hosting/migration-guide" }, { "destination": "/docs/self-hosting/configuration/integrations", "source": "/docs/self-hosting/integrations" }, { "destination": "/docs/self-hosting/advanced/license", "source": "/docs/self-hosting/license" }, { "destination": "/docs/self-hosting/advanced/rate-limiting", "source": "/docs/self-hosting/rate-limiting" }, { "destination": "/docs/self-hosting/setup/cluster-setup", "source": "/docs/self-hosting/kubernetes" }, { "destination": "/docs/development/overview", "source": "/docs/developer-docs/overview" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides", "source": "/docs/developer-docs/js-sdk" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/framework-guides#react-native", "source": "/docs/developer-docs/react-native-in-app-surveys" }, { "destination": "/docs/api-reference/rest-api", "source": "/docs/developer-docs/rest-api" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/webhooks", "source": "/docs/developer-docs/webhooks" }, { "destination": "/docs/development/contribution/contribution", "source": "/docs/developer-docs/contributing/get-started" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/actions", "source": "/docs/app-surveys/actions" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting", "source": "/docs/app-surveys/advanced-targeting" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/user-identification", "source": "/docs/app-surveys/user-identification" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/recontact", "source": "/docs/app-surveys/recontact" }, { "destination": "/docs/xm-and-surveys/surveys/website-app-surveys/show-survey-to-percent-of-users", "source": "/docs/app-surveys/global/show-survey-to-percent-of-users" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/metadata", "source": "/docs/app-surveys/global/metadata" }, { "destination": "/docs/api-reference", "source": "/docs/api-docs" }, { "destination": "/docs/development/troubleshooting", "source": "/docs/developer-docs/contributing/troubleshooting" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/file-upload", "source": "/docs/core-features/global/question-type/file-upload" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/select-picture", "source": "/docs/core-features/global/question-type/picture-selection" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/rating", "source": "/docs/core-features/global/question-type/rating" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/date", "source": "/docs/core-features/global/question-type/date" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/schedule-a-meeting", "source": "/docs/core-features/global/question-type/schedule" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/free-text", "source": "/docs/core-features/global/question-type/free-text" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/select-single", "source": "/docs/core-features/global/question-type/single-select" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/select-multiple", "source": "/docs/core-features/global/question-type/multiple-select" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/matrix", "source": "/docs/core-features/global/question-type/matrix" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/make", "source": "/docs/developer-docs/integrations/make" }, { "destination": "/docs/xm-and-surveys/core-features/integrations/overview", "source": "/docs/developer-docs/integrations/overview" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/hidden-fields", "source": "/docs/app-surveys/global/hidden-fields" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/limit-submissions", "source": "/docs/app-surveys/global/limit-submissions" }, { "destination": "/docs/xm-and-surveys/core-features/question-type/net-promoter-score", "source": "/docs/core-features/global/question-type/net-promoter-score" }, { "destination": "/docs/xm-and-surveys/surveys/link-surveys/data-prefilling", "source": "/docs/link-surveys/data-prefilling" }, { "destination": "/docs/xm-and-surveys/surveys/general-features/multi-language-surveys", "source": "/docs/app-surveys/global/multi-language-surveys" } ], "theme": "mint" }