Formbricks for AI agents
Agents read Formbricks at once. Changes and sends are held for a person's approval by default.
About Formbricks
Formbricks is an open-source platform for building and managing surveys, enabling organizations to collect and analyze user feedback effectively.
What an agent can do in Formbricks
Every Formbricks action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Formbricks without asking first. 24 actions.
- List Client EnvironmentTool to retrieve environment state for Formbricks SDKs. Use when you need to fetch the complete environment configuration including surveys, action classes, and project settings. Note: This endpoint u
- List Contact Attribute KeysTool to retrieve contact attribute keys from Formbricks. Use when you need to list all available contact attributes for segmentation, filtering, or contact management. Supports pagination, sorting, an
- List Management MeTool to retrieve authenticated user's environment and project information. Use when you need to get details about the environment associated with the current API key, including project details and set
- List Management PeopleTool to retrieve all people (legacy term for contacts) in the environment. Use when you need a complete list of people with their attributes.
- Check HealthTool to check the health status of the Formbricks API. Use when you need to verify that the API is operational and responding to requests.
- Get Account InfoRetrieves environment information for the authenticated API key. Returns details about the environment (development or production) including the associated project and setup completion status. This is
- Get All ContactsTool to retrieve all contacts within the organization. Use when you need a complete list of contacts.
- Get Attribute ClassTool to get a specific attribute class by ID. Use when you need to retrieve details of a specific attribute class for inspection or validation.
- Get Client Contacts StateTool to get the current state of a contact including surveys and segment information. Use when you need to retrieve tracking data for a specific user, including their segment memberships, survey displ
- Get Contact Attribute KeyTool to retrieve detailed information about a specific contact attribute key by ID (v2 API). Use when you need to inspect the properties of a contact attribute key such as its type, uniqueness require
- Get Contact by IDTool to retrieve a specific contact by its ID. Use when you need to fetch detailed information about a single contact.
- Get MeTool to retrieve current authenticated organization's and environment details. Use when you need to fetch organization and environment information for the current API key.
Show all 24
- Get Person by IDTool to retrieve a person by their internal ID in Formbricks. Use when you need detailed information about a specific person, including all their custom attributes. The person ID can be obtained from
- Get ResponsesRetrieve survey responses with flexible filtering, sorting, and pagination. Use this tool to: - List all responses across surveys or filter by specific surveyId - Filter responses by contactId to see
- Get RolesTool to retrieve all available roles in the system. Use when you need system roles for access control.
- Get WebhookTool to retrieve details of a specific webhook. Use when you need to inspect a webhook's configuration by ID.
- List Action ClassesList all action classes in your Formbricks environment. Action classes define trackable user interactions (like clicks, page views, form submissions) that can trigger surveys or be used in targeting l
- List Attribute ClassesTool to list all attribute classes. Use when you need to retrieve existing attribute classes for segmentation or management.
- List HealthTool to check the health status of critical application dependencies including database and cache. Use when you need to verify that Formbricks services are operational.
- List Management Contact AttributesTool to retrieve all contact attributes in the environment. Use when you need to view custom data stored for contacts across the organization.
- List Organizations Project TeamsTool to list all project-team assignments for an organization (v2 API only). Use when you need to retrieve which teams are assigned to which projects, along with their permission levels. Supports filt
- List Organization TeamsTool to retrieve all teams in an organization (v2 API). Use when you need to list teams within a specific organization, with support for pagination, sorting, and date-based filtering. Returns team det
- List SurveysList all surveys in the environment. Use this tool to: - Retrieve all surveys with complete configuration details - Access survey questions, endings, triggers, and styling - View survey status and met
- List WebhooksList all webhooks configured for the current environment. Returns webhooks with pagination support and optional filtering by survey IDs, date ranges, and sorting. Use this action to retrieve webhook c
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 21 actions.
- Create Client UserTool to create or identify a user within a specified environment. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new
- Create Action ClassTool to create a new action class. Use when defining custom action logic in your environment.
- Create Attribute ClassCreates a new attribute class (custom contact attribute) in Formbricks. Attribute classes define the schema for contact attributes used for segmentation and personalization. Each attribute must have a
- Create ContactCreates a new contact in a Formbricks environment. A contact represents a person or entity tracked in Formbricks for survey responses and interactions. The email serves as the unique identifier within
- Create DisplayCreate a display record to track when a survey is shown to users. Displays are used to measure survey view counts and can optionally be linked to a specific user. Use this after obtaining valid survey
- Create Survey ResponseTool to create a response for a survey. Use after collecting all survey answers.
- Create SurveyTool to create a new survey. Use after defining survey details and questions.
- Create WebhookTool to create a new webhook. Use when you need to register an external endpoint to receive form response events.
- Delete Attribute ClassTool to delete an attribute class. Use when you need to remove an attribute class by its ID after confirming it's no longer needed.
- Delete PersonTool to delete a person. Use when you need to remove a person's record from Formbricks after confirming the ID.
- Delete Survey ResponseTool to delete a survey response by its ID. Use when you need to remove an existing response after confirming its ID.
- Delete SurveyDeletes a survey from Formbricks by its unique identifier. Use this action when you need to permanently remove a survey. The deletion cannot be undone. Before deletion, ensure you have the correct sur
Show all 21
- Delete TeamTool to delete an organization team by its ID. Use when you need to permanently remove a team from an organization. Requires write permissions on the organization. Returns the deleted team's details i
- Delete WebhookTool to delete a webhook by ID. Use when you need to remove an existing webhook from Formbricks. Use after confirming the webhook ID.
- Update Contact AttributesTool to update a contact's attributes in Formbricks. Use when you need to keep contact information in sync with your app or set custom attributes.
- Update Survey ResponseTool to update an existing survey response. Use after identifying the response to modify.
- Update SurveyUpdates an existing Formbricks survey with new properties. Only include fields you want to modify - all fields except 'id' are optional. Common use cases: - Change survey status (e.g., from 'draft' to
- Update WebhookTool to update an existing webhook. Use when you need to apply modifications to a webhook's configuration.
- Upload Bulk ContactsUpload multiple contacts to a Formbricks environment in bulk (up to 250 per request). Each contact must include an 'email' attribute with a valid email address. Additional attributes like firstName, l
- Upload Private FileTool to obtain S3 presigned upload data for a private survey file. Use after confirming environmentId and surveyId.
- Upload Public FileRetrieves S3 presigned upload URLs and form fields for uploading a public file to Formbricks storage. Returns signed URL and presigned fields needed to upload files directly to S3. Maximum file size:
Changes wait in Needs you
Changes and sends in Formbricks are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Formbricks questions
Can an agent change data in Formbricks on its own?
Not by default. Changes and sends in Formbricks are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Formbricks?
This connector lists 24 read actions. Reads run at once, without waiting for approval.
How does Formbricks connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.