DOCSEARCHbyAlgolia
Submit Docs

Formbricks API Reference

website·Indexed 38 days ago

https://formbricks.com/docs

Documentation for the Formbricks REST APIs, including the Public Client API for frontend survey interactions and the Management API for backend tasks. Covers survey creation, response management, user identification, webhook configuration, and workspace state retrieval across v1 and v2 endpoints.

Tokens
140.4K
Snippets
464
Records
1K
Agent score
69%

What's inside Formbricks

  1. Overview of Formbricks API types

    Formbricks provides two distinct APIs based on the required access level and environment:

    1. Public Client API: Designed for frontend survey interactions and used by SDKs. It does not require authentication, ensuring sensitive data is not exposed on the client side.
    2. Management API: Provides full access to all account data and settings. It requires a personal API Key for authentication, which is managed within the Formbricks app Settings.

  2. Overview of Formbricks Survey capabilities

    Formbricks allows you to design, distribute, and analyze surveys to collect feedback from customers, users, and employees. It supports three primary distribution methods: standalone public links, embedded website surveys, and triggered in-app surveys.

  3. Overview of Multi-language Surveys

    Multi-language surveys allow a single survey (with one set of questions, logic, and results) to be translated into multiple languages. All responses, regardless of the language used by the respondent, are collected into a single dataset. The method for determining which language a respondent sees depends on the survey type:

    • Link Surveys: Determined by the lang URL parameter or a manual selection via the language switch. If a translation is missing, it falls back to the survey's default language.
    • App & Website Surveys: Determined by the language attribute set via the SDK. If a translation is missing, the survey is not shown to the user.

  4. Overview of the Formbricks Job Runner

    Formbricks uses a shared BullMQ Job Runner for asynchronous tasks such as response processing, survey scheduling, and workflows. By default, the worker starts inside the web application, meaning a separate worker container is not required for standard self-hosted deployments. The system uses a Redis-backed queue named background-jobs with the Redis key prefix {formbricks:jobs}.

  5. Overview of Formbricks Tags

    Tags are workspace-specific labels applied to individual survey responses. They are used to categorize responses by topic, sentiment, or custom criteria, allowing users to filter specific subsets of data and organize feedback across multiple surveys. Each workspace maintains its own independent set of tags.

  6. Overview of Formbricks Workflows

    Workflows allow you to automate tasks in response to events in Formbricks. A workflow consists of a trigger to start the process, optional filters to narrow down qualifying events, and an action to perform. Workflows are currently in Beta and are part of the Formbricks Enterprise Edition. They can be found under the 'Act' section of the application.

  7. Overview of Formbricks Feedback Sources

    Feedback Sources define how external data is mapped into Feedback Records within a Feedback Dataset. They allow users to bring in data from various origins to centralize feedback analysis. Sources can be managed by navigating to Analyze → Feedback Data → Feedback Sources.

  8. Overview of Formbricks API v2 Types

    Formbricks provides two distinct APIs: the Public Client API and the Management API. These APIs differ in their purpose, authentication requirements, and the specific data and settings they allow you to access.

  9. Overview of Custom Head Scripts for Link Surveys

    Custom Head Scripts allow you to inject custom HTML code (such as tracking pixels, analytics, chatbots, or meta tags) into the <head> section of Link Surveys.

    Critical Constraints:

    • Self-Hosted Only: This feature is only available for self-hosted instances. It is NOT available on Formbricks Cloud.
    • Link Surveys Only: This only works for Link Surveys. It is NOT available for Website or App Surveys (which should use the host application's script management).
    • Preview Mode: Scripts do not load in preview mode (editor preview or ?preview=true) to prevent skewed analytics. Test scripts using the actual published survey URL.
    • Permissions: Only Owners, Managers, and members with 'Manage' access can configure these scripts.

  10. Overview of AI Enrichment for Feedback Records

    AI Enrichment automatically analyzes open-text feedback records (those with a value_text field) to add structured signals. This process is asynchronous and per-record. Enrichment includes three main components:

    1. Sentiment: Classifies feedback on a polarity scale (Very positive to Very negative) with a score from -1.0 to 1.0.
    2. Emotions: Detects one or more of six emotions (Joy, Anger, Sadness, Fear, Surprise, Disgust).
    3. Language Consolidation: Translates text into a common organization-wide target language for unified analysis.

    Records containing only ratings, NPS scores, or categorical choices are not AI-enriched. Editing a record's value_text clears existing enrichment and re-queues it for processing; editing the language field only re-runs the translation.

  11. Overview of Formbricks Unify Feedback

    Unify Feedback is an enterprise feature in Formbricks (found under the 'Analyze' section in the app) that consolidates feedback from various sources—such as surveys, CSV imports, and API ingestions—into a single, queryable store. It normalizes disparate data schemas into 'Feedback Records' grouped within 'Feedback Datasets', allowing users to filter, visualize, and analyze feedback across their entire stack in one place.

    Key capabilities include:

    • Data Normalization: Converts various feedback sources into a consistent model.
    • Enrichment: Automatically adds sentiment, emotions, and language consolidation to open-text feedback.
    • Topic Discovery: Uses vector-based clustering to identify Topics and Subtopics (Preview).
    • Visualization: Create Charts and Dashboards to share insights.

    Availability: This is an enterprise feature. It requires a paid plan on Formbricks Cloud or a license for self-hosted installations.

  12. Overview of Formbricks Cloud third-party integrations

    Formbricks Cloud supports several third-party integrations to automate workflows and sync survey responses to external tools. Available integrations include:

    • Automation Platforms: ActivePieces (Open Source), Make, n8n (Open Source), and Zapier (connects to 2000+ apps).
    • Data & CRM Sync: Airtable, Google Sheets, HubSpot (create/update contacts), and Notion.
    • Notifications & CMS: Slack (send responses to channels) and WordPress (Open Source).
    • Custom Endpoints: Webhooks for sending real-time HTTP notifications to any endpoint.

    For automations that do not require a third-party tool (e.g., sending an email upon response completion), use the internal Formbricks Workflows feature.