Skip to main content
Formbricks logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 45
  • Triggers: 0
  • Slug: FORMBRICKS
  • Version: 20261101_00

Tools

Slug: FORMBRICKS_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_CREATE_ACTION_CLASSTool to create a new action class. Use when defining custom action logic in your environment.

Input Parameters

string
required
Unique key identifier for the Action Class
string
required
Name of the Action Class
string ("code" | "noCode")
required
Type of the Action Class, either ‘code’ or ‘noCode’
string
Optional description of the Action Class
object
Configuration for no-code action type. Required when type=‘noCode’. Must include ‘type’ (one of ‘click’, ‘pageView’, ‘exitIntent’) and ‘urlFilters’ (list). For ‘click’, ‘elementSelector’ is also required.
string
required
Environment ID where this action class belongs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 unique key within the environment. Common examples include ‘plan’, ‘tier’, ‘company’, or custom business-specific attributes. Use this when you need to define new contact attribute types before tracking user data.

Input Parameters

string
required
Unique identifier key for this attribute (e.g., ‘customer_tier’, ‘plan_type’). Must be unique within the environment.
string
Human-readable display name for the attribute. If not provided, defaults to the key.
string
Type of attribute class. Must be ‘custom’ for user-defined attributes.
boolean
Whether attribute values must be unique across all contacts (e.g., true for email, false for plan tier)
string
Optional description providing additional context about this attribute’s purpose and usage
string
required
Environment ID where this attribute class will be created. Get from GET_ME action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 user. Use when you need to register or update users in the client API for survey targeting.

Input Parameters

string
required
Unique identifier for the user. This serves as the primary identifier for the user within the environment.
object
Custom user attributes for targeting and personalization. These can include any key-value pairs that help identify or segment the user (e.g., plan type, source, user preferences). All values should be strings. Attributes are optional but useful for targeting surveys.
string
required
The environment ID where the user will be created or identified. Use GET_ME action to retrieve available environment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 an environment - if a contact with the same email already exists, this will update the existing contact. Use this action when you need to: - Register a new contact for survey distribution - Add contact information before sending surveys - Create or update contact records with custom attributes Prerequisites: - An environment ID (use GET_ME to retrieve available environments) - All attribute keys must exist in the environment (email is always available) - Write permissions on the API key

Input Parameters

object
required
Key-value pairs of contact attributes. The ‘email’ key is required and serves as the unique identifier. All attribute keys must already exist in the environment. Common attributes include: email (required), firstName, lastName, userId. Only string values are supported.
string
required
The environment ID where the contact will be created. Use GET_ME action to retrieve available environment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 and environment IDs to register that a survey was displayed.

Input Parameters

string
Optional user ID to associate this display with a specific user for tracking purposes.
string
required
The survey ID to track as displayed. Must be a valid cuid2 format identifier.
string
required
The environment ID where the survey exists. Must be a valid cuid2 format identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_CREATE_RESPONSETool to create a response for a survey. Use after collecting all survey answers.

Input Parameters

object
(Optional) Time-to-complete metrics. Flat map of string keys to numeric millisecond values (e.g. {‘total’: 42, ‘q1’: 10}); nested objects are not accepted by the API.
object
required
The answers/data for the survey response
object
Metadata about the response context.
string
(Optional) ID of the ending reached. Must be a Formbricks CUID2 string (24-32 lowercase alphanumeric chars), not a UUID.
boolean
required
Whether the response is finished
string
(Optional) Language code of the response, e.g., ‘en’
string
required
The ID of the survey for which to create the response
string
(Optional) Creation timestamp in ISO 8601 format
string
(Optional) Display ID for the response
string
(Optional) Last update timestamp in ISO 8601 format
object
(Optional) Custom variables associated with the response
string
(Optional) Single-use ID for the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_CREATE_SURVEYTool to create a new survey. Use after defining survey details and questions.

Input Parameters

string
required
Survey name
string ("link" | "app")
required
Survey display type
string ("draft" | "inProgress" | "paused" | "completed")
Survey status. Defaults to ‘draft’ for newly created surveys; mirrors the Formbricks API which treats this field as optional on creation.
array
required
List of questions in the survey
string
required
Environment ID to create the survey in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_CREATE_WEBHOOKTool to create a new webhook. Use when you need to register an external endpoint to receive form response events.

Input Parameters

string
required
Target URL for the webhook; must be a valid URI that will receive webhook calls.
string
Optional name of the webhook for identification purposes.
array
required
List of events that will trigger the webhook; allowed values: responseCreated, responseUpdated, responseFinished
array
Optional list of survey IDs to filter webhook calls. If empty or not provided, webhook listens to all surveys in the environment.
string
required
ID of the environment where the webhook will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Input Parameters

string
required
ID of the attribute class to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_DELETE_PERSONTool to delete a person. Use when you need to remove a person’s record from Formbricks after confirming the ID.

Input Parameters

string
required
ID of the person to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_DELETE_RESPONSETool to delete a survey response by its ID. Use when you need to remove an existing response after confirming its ID.

Input Parameters

string
required
Unique identifier of the response to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_DELETE_SURVEYDeletes a Formbricks survey by its unique identifier. Deleted survey details may be returned when supplied by the API.

Input Parameters

string
required
The unique identifier of the survey to delete. Must be a valid survey ID from your Formbricks environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_DELETE_TEAMDeletes an organization team by organization and team ID. Deleted team details may be returned when supplied by the API.

Input Parameters

string
required
ID of the team to delete (CUID2 format, typically starts with ‘cm’).
string
required
ID of the organization (CUID2 format, typically starts with ‘cm’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Input Parameters

string
required
The ID of the webhook to delete. Must be a valid CUID2 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 useful for understanding which environment and project you’re working with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_GET_ALL_CONTACTSTool to retrieve all contacts within the organization. Use when you need a complete list of contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Input Parameters

string
required
Unique identifier of the attribute class to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_GET_CLIENT_CONTACTS_STATERetrieves the current state of a contact for a specific user, including segment memberships, survey displays, and response history, using the v1 client API.

Input Parameters

string
required
The user ID (not contactId) to retrieve state for. This is the userId field, not the internal contactId.
string
required
The environment ID where the contact exists. Use GET_ME action to retrieve available environment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 requirement, or associated environment.

Input Parameters

string
required
The unique identifier of the contact attribute key to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_GET_CONTACT_BY_IDTool to retrieve a specific contact by its ID. Use when you need to fetch detailed information about a single contact.

Input Parameters

string
required
The ID of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 the Get All Persons endpoint.

Input Parameters

string
required
The internal ID of the person to retrieve. This ID can be obtained from the Get All Persons endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 submissions from a specific contact - Apply date range filters (startDate/endDate) with filterDateField - Sort by creation or update time (sortBy: createdAt/updatedAt) - Paginate through large result sets (limit: 1-250, skip for offset) Returns detailed response data including answers, completion status, timestamps, contact attributes, time-to-complete metrics, and pagination metadata.

Input Parameters

integer
Number of items to skip for pagination
integer
Number of items to return (1-250)
string ("asc" | "desc")
Sort order: ‘asc’ (ascending) or ‘desc’ (descending)
string ("createdAt" | "updatedAt")
Field to sort by: ‘createdAt’ or ‘updatedAt’
string
ISO 8601 end date to filter responses (inclusive)
string
Filter responses by survey ID (must be valid cuid2 format)
string
Filter responses by contact ID
string
ISO 8601 start date to filter responses (inclusive)
string ("createdAt" | "updatedAt")
Date field to filter on when using startDate/endDate: ‘createdAt’ or ‘updatedAt’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_GET_ROLESTool to retrieve all available roles in the system. Use when you need system roles for access control.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_GET_WEBHOOKTool to retrieve details of a specific webhook. Use when you need to inspect a webhook’s configuration by ID.

Input Parameters

string
required
Unique identifier of the webhook to retrieve (CUID2 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 logic. Use this to discover what actions are available for survey triggers and audience segmentation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_LIST_ATTRIBUTE_CLASSESTool to list all attribute classes. Use when you need to retrieve existing attribute classes for segmentation or management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 uses server-side caching with a 5-minute TTL, so changes may take up to 5 minutes to reflect.

Input Parameters

string
required
The ID of the environment to retrieve state for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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, and date filtering.

Input Parameters

integer
Number of items to skip for pagination (default: 0)
integer
Number of items to return (default: 50)
string ("asc" | "desc")
Enum for sort order values
string ("createdAt" | "updatedAt")
Enum for sortBy field values
string
End date for filtering (ISO 8601 format)
string
Start date for filtering (ISO 8601 format)
string
Filter by specific environment ID
string ("createdAt" | "updatedAt")
Enum for filterDateField values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 setup status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 filtering by team, project, date range, and pagination.

Input Parameters

integer
Number of project-team assignments to skip for pagination. Defaults to 0.
integer
Number of project-team assignments to return. Defaults to 50.
string ("asc" | "desc")
Sort order options.
string ("createdAt" | "updatedAt")
Sort field options for project teams list.
string
Filter by specific team ID.
string
End date for filtering project teams (ISO 8601 format).
string
Filter by specific project ID.
string
Start date for filtering project teams (ISO 8601 format).
string
required
The ID of the organization to retrieve project teams from.
string ("createdAt" | "updatedAt")
Date field options for filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 details including ID, name, timestamps, and organization ID.

Input Parameters

integer
Number of teams to skip before starting to return results (pagination offset). Use with ‘limit’ to implement pagination. Defaults to 0.
integer
Maximum number of teams to return per page (pagination). Defaults to 50 if not specified.
string ("asc" | "desc")
Enum for sort order options.
string ("createdAt" | "updatedAt")
Enum for sortBy field options.
string
Filter teams created or updated on or before this date (ISO 8601 format). Use with ‘startDate’ and ‘filterDateField’ to define a date range.
string
Filter teams created or updated on or after this date (ISO 8601 format). Use with ‘endDate’ and ‘filterDateField’ to define a date range.
string
required
ID of the organization to list teams from (CUID2 format, typically starts with ‘cm’).
string ("createdAt" | "updatedAt")
Enum for date field filtering options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 metadata (created/updated timestamps, creator) - Get display settings, targeting, and language configurations Returns complete survey objects including questions, endings, welcome cards, triggers, display options, styling, and all other configuration settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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 configurations, check which surveys have webhooks enabled, or audit webhook settings.

Input Parameters

integer
Number of webhooks to skip before starting to return results (pagination offset). Use with ‘limit’ to implement pagination. Defaults to 0.
integer
Maximum number of webhooks to return per page (1–250). Defaults to 50 if not specified. Use with ‘skip’ for pagination.
string ("asc" | "desc")
Sort order: ‘asc’ for ascending (oldest/earliest first) or ‘desc’ for descending (newest/latest first). Must be used with ‘sortBy’ parameter.
string ("createdAt" | "updatedAt")
Sort webhooks by creation date (‘createdAt’) or last modification date (‘updatedAt’). Must be used with ‘order’ parameter.
string
Filter webhooks created or updated on or before this date (ISO 8601 format). Use with ‘startDate’ to define a date range.
string
Filter webhooks created or updated on or after this date (ISO 8601 format). Use with ‘endDate’ to define a date range.
array
Filter to only return webhooks associated with these specific survey IDs. Provide a list of survey ID strings to filter results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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.

Input Parameters

string
required
The contact’s user ID to update attributes for.
object
required
Key-value pairs of contact attributes to update. Common attributes include: firstName, lastName, email, role, company. You can also set custom attributes. All attribute keys must already exist in the environment. All values must be strings.
string
required
The environment ID where the contact exists. Use GET_ME action to retrieve available environment IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_UPDATE_RESPONSETool to update an existing survey response. Use after identifying the response to modify.

Input Parameters

string
required
Unique identifier of the response to update
object
(Optional) Time-to-complete metrics
object
required
The answers/data for the survey response
object
(Optional) Metadata about the response, e.g., source, url, userAgent, country
string
(Optional) ID of the ending reached
boolean
required
Whether the response is finished
string
(Optional) Language code of the response, e.g., ‘en’
string
required
The ID of the survey for which to update the response
string
(Optional) Contact ID
string
(Optional) Creation timestamp in ISO 8601 format
string
(Optional) Display ID for the response
string
(Optional) Last update timestamp in ISO 8601 format
object
(Optional) Custom variables associated with the response
string
(Optional) Single-use ID for the response
object
(Optional) Contact attributes snapshot

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_UPDATE_SURVEYUpdates an existing Formbricks survey by ID, including its status, name, display settings, questions, welcome card, endings, and triggers. Only supplied optional fields are sent.

Input Parameters

string
required
The ID of the survey to update
string
New name for the survey
number
Display delay in seconds before showing survey
string ("draft" | "inProgress" | "paused" | "completed")
Survey status: ‘draft’ (not yet live), ‘inProgress’ (active and visible to users), ‘paused’ (temporarily stopped), or ‘completed’ (finished)
array
List of ending screen configurations with properties: ‘type’ (str), ‘headline’ (dict), ‘subheader’ (dict), ‘buttonLabel’ (dict), ‘buttonLink’ (str)
array
List of trigger events that determine when the survey appears (e.g., page URL, code action, exit intent)
array
List of ISO 639-1 language codes enabled for the survey
array
List of survey questions, each with: ‘id’ (str), ‘type’ (openText/multipleChoiceSingle/multipleChoiceMulti/etc), ‘required’ (bool), ‘headline’ (dict with language keys), and type-specific properties
string
URL to redirect users to after completing the survey
object
Welcome screen configuration with properties: ‘enabled’ (bool), ‘headline’ (dict), ‘html’ (dict), ‘fileUrl’ (str), ‘showResponseCount’ (bool), ‘timeToFinish’ (int)
integer
Maximum number of times survey can be displayed to a user
object
Hidden fields configuration with ‘enabled’ (bool) and ‘fieldIds’ (list of field IDs to hide)
string ("displayOnce" | "displayMultiple" | "respondMultiple")
Display frequency: ‘displayOnce’ (show once per user), ‘displayMultiple’ (show multiple times), or ‘respondMultiple’ (allow multiple responses)
number
Percentage of users who will see the survey (0-100)
boolean
Whether to display a language switcher in the survey UI
string
Custom message displayed when the survey is no longer accepting responses
boolean
Whether to require email verification before survey submission

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_UPDATE_WEBHOOKUpdates an existing webhook’s configuration by ID. The request requires the webhook’s name, URL, source, environment, triggers, and survey IDs; the name may be null.

Input Parameters

string
required
The ID of the webhook to update.
string
required
Target URL for the webhook; must be a valid URI.
string
required
The name of the webhook. Set to null to clear the existing name.
string ("user" | "zapier" | "make" | "n8n")
required
Source of the webhook; one of ‘user’, ‘zapier’, ‘make’, ‘n8n’.
array
required
List of events that will trigger the webhook; allowed values: responseCreated, responseUpdated, responseFinished. Must include at least one entry.
array
required
List of survey IDs the webhook applies to.
string
required
The ID of the environment associated with the webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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, lastName, or custom fields can be included. The API returns status 200 for full success or 207 for partial success with details about skipped contacts. Use this tool when you need to efficiently import multiple contacts at once instead of creating them individually.

Input Parameters

array
required
List of contact objects to upload. Minimum 1, maximum 250 contacts per request. Each contact must have a valid email attribute.
string
required
The Formbricks environment ID where contacts will be created. Obtain this from the Get Me action or your Formbricks dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_UPLOAD_PRIVATE_FILETool to obtain S3 presigned upload data for a private survey file. Use after confirming environmentId and surveyId.

Input Parameters

string
required
Name of the file to upload (including extension), e.g., ‘report.pdf’.
string
required
MIME type of the file, e.g., ‘application/pdf’.
string
required
The ID of the survey associated with the file.
string
required
Environment ID of the Formbricks instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMBRICKS_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: 5MB. Uploaded files are publicly accessible. Requires write permissions on the specified environment.

Input Parameters

string
required
Name of the file to be uploaded (including extension)
string
required
MIME type of the file (e.g., ‘image/png’)
string
required
The environment ID where the file will be uploaded
array
Optional list of allowed file extensions (without dot) to restrict upload types. If omitted, all default extensions are allowed: heic, png, jpeg, jpg, webp, ico, pdf, eml, doc, docx, xls, xlsx, ppt, pptx, txt, csv, mp4, mov, avi, mkv, webm, mp3, zip, rar, 7z, tar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not