Formbricks

formbricks

Formbricks is an open-source platform for building and managing surveys, enabling organizations to collect and analyze user feedback effectively.

Forms & Surveys Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (31)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Action ClassFORMBRICKS_CREATE_ACTION_CLASSAcción

Tool to create a new action class. Use when defining custom action logic in your environment.

Parámetros de entrada

keystringObligatorio
Unique key identifier for the Action Class
namestringObligatorio
Name of the Action Class
typestringObligatorioenum
Type of the Action Class, either 'code' or 'noCode'
codenoCode
descriptionstring
Optional description of the Action Class
noCodeConfigobject
Optional configuration for no-code action type
environmentIdstringObligatorio
Environment ID where this action class belongs

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Attribute ClassFORMBRICKS_CREATE_ATTRIBUTE_CLASSAcción

Tool to create an attribute class in Formbricks. Use when you need to define new attribute classes for segmentation or attributes management.

Parámetros de entrada

keystringObligatorio
Unique key for the attribute class
namestring
Display name for the attribute class
typestring
Type of attribute class; must be 'custom' for user-defined
isUniqueboolean
Whether the attribute value must be unique
descriptionstring
Optional description
environmentIdstringObligatorio
Environment ID where this attribute belongs

Parámetros de salida

dataobjectObligatorio
Created attribute class data
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ContactFORMBRICKS_CREATE_CONTACTAcción

Tool to create a new contact. Use when you need to register a contact in a Formbricks environment.

Parámetros de entrada

attributesobjectObligatorio
Key/value attributes for the contact; must include 'email' and all keys must exist in the environment.
environmentIdstringObligatorio
Environment ID to create the contact in.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create DisplayFORMBRICKS_CREATE_DISPLAYAcción

Tool to mark a survey as displayed or link it to a response. Use after obtaining the survey and environment IDs to register a display instance.

Parámetros de entrada

userIdstring
(Optional) User ID to link the display to.
surveyIdstringObligatorio
Survey ID to create the display for.
environmentIdstringObligatorio
The ID of the environment.

Parámetros de salida

dataobjectObligatorio
Response wrapper containing display information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Survey ResponseFORMBRICKS_CREATE_RESPONSEAcción

Tool to create a response for a survey. Use after collecting all survey answers.

Parámetros de entrada

ttcobject
(Optional) Time-to-complete metrics
dataobjectObligatorio
The answers/data for the survey response
metaobject
(Optional) Metadata about the response, e.g., source, url, userAgent, country
endingIdstring
(Optional) ID of the ending reached
finishedbooleanObligatorio
Whether the response is finished
languagestring
(Optional) Language code of the response, e.g., 'en'
surveyIdstringObligatorio
The ID of the survey for which to create the response
createdAtstring
(Optional) Creation timestamp in ISO 8601 format
displayIdstring
(Optional) Display ID for the response
updatedAtstring
(Optional) Last update timestamp in ISO 8601 format
variablesobject
(Optional) Custom variables associated with the response
singleUseIdstring
(Optional) Single-use ID for the response

Parámetros de salida

idstringObligatorio
The ID of the created response
ttcobject
(Optional) Time-to-complete metrics
dataobjectObligatorio
The answers/data for the survey response
metaobject
(Optional) Metadata about the response
errorstring
Error if any occurred during the execution of the action
endingIdstring
(Optional) Ending ID reached
finishedbooleanObligatorio
Whether the response is finished
languagestring
(Optional) Language code of the response
surveyIdstringObligatorio
The survey ID associated with the response
contactIdstring
(Optional) Contact ID if linked
createdAtstringObligatorio
Creation timestamp of the response
displayIdstring
(Optional) Display ID for the response
updatedAtstringObligatorio
Last update timestamp of the response
variablesobject
(Optional) Custom variables associated with the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
singleUseIdstring
(Optional) Single-use ID for the response
contactAttributesobject
(Optional) Attributes of the contact

Create SurveyFORMBRICKS_CREATE_SURVEYAcción

Tool to create a new survey. Use after defining survey details and questions.

Parámetros de entrada

namestringObligatorio
Survey name
typestringObligatorioenum
Survey display type
linkapp
questionsobject[]Obligatorio
List of questions in the survey
environmentIdstringObligatorio
Environment ID to create the survey in

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookFORMBRICKS_CREATE_WEBHOOKAcción

Tool to create a new webhook. Use when you need to register an external endpoint to receive form response events.

Parámetros de entrada

urlstringObligatorio
Target URL for the webhook; must be a valid URI.
namestringObligatorio
Name of the webhook.
sourcestringObligatorioenum
Source of the webhook; one of 'user', 'zapier', 'make', 'n8n'.
userzapiermaken8n
triggersstring[]Obligatorio
List of events that will fire the webhook; allowed values: responseCreated, responseUpdated, responseFinished
surveyIdsstring[]Obligatorio
List of survey IDs the webhook listens to.
environmentIdstringObligatorio
ID of the associated environment.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Attribute ClassFORMBRICKS_DELETE_ATTRIBUTE_CLASSAcción

Tool to delete an attribute class. Use when you need to remove an attribute class by its ID after confirming it's no longer needed.

Parámetros de entrada

idstringObligatorio
ID of the attribute class to delete.

Parámetros de salida

dataobjectObligatorio
Deleted attribute class object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete PersonFORMBRICKS_DELETE_PERSONAcción

Tool to delete a person. Use when you need to remove a person's record from Formbricks after confirming the ID.

Parámetros de entrada

personIdstringObligatorio
ID of the person to delete.

Parámetros de salida

dataobjectObligatorio
Data returned when a person is successfully deleted.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Survey ResponseFORMBRICKS_DELETE_RESPONSEAcción

Tool to delete a survey response by its ID. Use when you need to remove an existing response after confirming its ID.

Parámetros de entrada

idstringObligatorio
Unique identifier of the response to delete

Parámetros de salida

idstringObligatorio
ID of the deleted response
ttcobjectObligatorio
Time-to-complete metrics per question
dataobjectObligatorio
Answers/data keyed by question ID
metaobjectObligatorio
Metadata about the response
tagsstring[]Obligatorio
List of tags attached to the response
errorstring
Error if any occurred during the execution of the action
personobjectObligatorio
Person details associated with the response
finishedbooleanObligatorio
Whether the response was completed
languagestring
Language code of the response
surveyIdstringObligatorio
The survey ID associated with the response
createdAtstringObligatorio
Creation timestamp of the response (ISO 8601)
updatedAtstringObligatorio
Last update timestamp of the response (ISO 8601)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
singleUseIdstring
Single-use link ID, if any
personAttributesobjectObligatorio
Flattened person attributes

Delete SurveyFORMBRICKS_DELETE_SURVEYAcción

Tool to delete a survey by its ID. Use when you need to remove a survey after confirming its ID.

Parámetros de entrada

idstringObligatorio
The ID of the survey to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TeamFORMBRICKS_DELETE_TEAMAcción

Tool to delete a team. Use when you need to remove a team by its ID after confirming it's no longer needed.

Parámetros de entrada

team_idstringObligatorio
ID of the team to delete.
organization_idstringObligatorio
ID of the organization.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookFORMBRICKS_DELETE_WEBHOOKAcción

Tool to delete a webhook by ID. Use when you need to remove an existing webhook from Formbricks. Use after confirming the webhook ID.

Parámetros de entrada

idstringObligatorio
The ID of the webhook to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account InfoFORMBRICKS_GET_ACCOUNT_INFOAcción

Tool to retrieve account information. Use when you need details about the authenticated Formbricks account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All ContactsFORMBRICKS_GET_ALL_CONTACTSAcción

Tool to retrieve all contacts within the organization. Use when you need a complete list of contacts.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of contact objects
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MeFORMBRICKS_GET_MEAcción

Tool to retrieve current authenticated organization's and environment details. Use when you need to fetch organization and environment information for the current API key.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ResponsesFORMBRICKS_GET_RESPONSESAcción

Tool to retrieve a list of survey responses. Use when you need to page, sort, or filter responses.

Parámetros de entrada

skipinteger
Number of items to skip for pagination
limitinteger
Number of items to return (1-250)
orderstringenum
Sort order: 'asc' (ascending) or 'desc' (descending)
ascdesc
sortBystringenum
Field to sort by: 'createdAt' or 'updatedAt'
createdAtupdatedAt
endDatestring
ISO 8601 end date to filter responses (inclusive)
surveyIdstring
Filter responses by survey ID
contactIdstring
Filter responses by contact ID
startDatestring
ISO 8601 start date to filter responses (inclusive)

Parámetros de salida

dataobject[]Obligatorio
List of response objects
metaobjectObligatorio
Pagination metadata
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RolesFORMBRICKS_GET_ROLESAcción

Tool to retrieve all available roles in the system. Use when you need system roles for access control.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

datastring[]Obligatorio
List of available role names
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UsersFORMBRICKS_GET_USERSAcción

Tool to retrieve a list of users within the environment using the Management API.

Parámetros de entrada

skipinteger
Number of users to skip (offset).
limitinteger
Maximum number of users to return per page; between 1 and 250.
organizationIdstring
Identifier of the organization (ignored on Cloud).

Parámetros de salida

dataobject[]Obligatorio
Array of user/person objects.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WebhookFORMBRICKS_GET_WEBHOOKAcción

Tool to retrieve details of a specific webhook. Use when you need to inspect a webhook's configuration by ID.

Parámetros de entrada

idstringObligatorio
Unique identifier of the webhook to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Action ClassesFORMBRICKS_LIST_ACTION_CLASSESAcción

Tool to list all action classes. Use when you need to inspect available action classes for workflows.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of action class objects
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Attribute ClassesFORMBRICKS_LIST_ATTRIBUTE_CLASSESAcción

Tool to list all attribute classes. Use when you need to retrieve existing attribute classes for segmentation or management.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of attribute classes
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List SurveysFORMBRICKS_LIST_SURVEYSAcción

Tool to list all surveys. Use when you need to retrieve a summary of all surveys available in the environment.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of survey summary objects
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksFORMBRICKS_LIST_WEBHOOKSAcción

Tool to list all webhooks. Use when you need to retrieve all configured webhooks for the current environment.

Parámetros de entrada

skipinteger
Number of items to skip (offset).
limitinteger
Number of items to return (1–250).
orderstringenum
Sort order.
ascdesc
sortBystringenum
Field to sort by.
createdAtupdatedAt
endDatestring
Filter: end date (ISO 8601).
startDatestring
Filter: start date (ISO 8601).
surveyIdsstring[]
Filter: list of survey IDs.

Parámetros de salida

dataobject[]Obligatorio
List of webhook objects.
metaobject
Pagination metadata, present in API v2
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update PersonFORMBRICKS_UPDATE_PERSONAcción

Tool to update an existing person. Use when you need to modify contact attributes in a Formbricks environment.

Parámetros de entrada

userIdstringObligatorio
ID of the user/contact (person) to update.
attributesobjectObligatorio
Key/value attributes to update for the person; keys must exist in the environment.
environmentIdstringObligatorio
Environment ID containing the person to update.

Parámetros de salida

dataobjectObligatorio
Result data for the update operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Survey ResponseFORMBRICKS_UPDATE_RESPONSEAcción

Tool to update an existing survey response. Use after identifying the response to modify.

Parámetros de entrada

idstringObligatorio
Unique identifier of the response to update
ttcobject
(Optional) Time-to-complete metrics
dataobjectObligatorio
The answers/data for the survey response
metaobject
(Optional) Metadata about the response, e.g., source, url, userAgent, country
endingIdstring
(Optional) ID of the ending reached
finishedbooleanObligatorio
Whether the response is finished
languagestring
(Optional) Language code of the response, e.g., 'en'
surveyIdstringObligatorio
The ID of the survey for which to update the response
contactIdstring
(Optional) Contact ID
createdAtstring
(Optional) Creation timestamp in ISO 8601 format
displayIdstring
(Optional) Display ID for the response
updatedAtstring
(Optional) Last update timestamp in ISO 8601 format
variablesobject
(Optional) Custom variables associated with the response
singleUseIdstring
(Optional) Single-use ID for the response
contactAttributesobject
(Optional) Contact attributes snapshot

Parámetros de salida

idstringObligatorio
The ID of the updated response
ttcobject
(Optional) Time-to-complete metrics
dataobjectObligatorio
The answers/data for the survey response
metaobject
(Optional) Metadata about the response
errorstring
Error if any occurred during the execution of the action
endingIdstring
(Optional) Ending ID reached
finishedbooleanObligatorio
Whether the response is finished
languagestring
(Optional) Language code of the response
surveyIdstringObligatorio
The survey ID associated with the response
contactIdstring
(Optional) Contact ID if linked
createdAtstringObligatorio
Creation timestamp of the response
displayIdstring
(Optional) Display ID for the response
updatedAtstringObligatorio
Last update timestamp of the response
variablesobject
(Optional) Custom variables associated with the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
singleUseIdstring
(Optional) Single-use ID for the response
contactAttributesobject
(Optional) Attributes of the contact

Update SurveyFORMBRICKS_UPDATE_SURVEYAcción

Tool to update an existing survey. Use after confirming survey ID to modify its properties.

Parámetros de entrada

idstringObligatorio
The ID of the survey to update
namestring
New name for the survey
delaynumber
Display delay in seconds
statusstring
New status for the survey, e.g., 'inProgress'
endingsarray
List of ending screen configurations
triggersarray
List of trigger configurations
languagesstring[]
List of language codes for the survey, e.g., ['en','de']
questionsarray
List of question definitions to update
redirectUrlstring
URL to redirect after survey completion
welcomeCardobject
Welcome card settings object
displayLimitinteger
Maximum display count
hiddenFieldsobject
Settings for hidden fields, e.g., {'enabled': True, 'fieldIds': ['q1','q2']}
displayOptionstring
Display option, e.g., 'displayOnce'
displayPercentagenumber
Display percentage threshold
showLanguageSwitchboolean
Whether to show language switch
surveyClosedMessagestring
Custom message when survey is closed
isVerifyEmailEnabledboolean
Enable or disable email verification

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update WebhookFORMBRICKS_UPDATE_WEBHOOKAcción

Tool to update an existing webhook. Use when you need to apply modifications to a webhook's configuration.

Parámetros de entrada

idstringObligatorio
The ID of the webhook to update.
urlstringObligatorio
Target URL for the webhook, must be a valid URI.
namestringObligatorio
The name of the webhook. Provide null to clear existing name.
sourcestringObligatorio
Source of the webhook; one of 'user', 'zapier', 'make', 'n8n'.
triggersstring[]Obligatorio
List of triggers for the webhook; must include at least one entry.
surveyIdsstring[]Obligatorio
List of survey IDs the webhook applies to.
environmentIdstringObligatorio
The ID of the environment associated with the webhook.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload Bulk ContactsFORMBRICKS_UPLOAD_BULK_CONTACTSAcción

Tool to upload multiple contacts in bulk. Use when you need to import up to 250 contacts at once.

Parámetros de entrada

contactsobject[]Obligatorio
List of contacts to upload (1 to 250 items).
environmentIdstringObligatorio
Target environment ID to upload contacts into.

Parámetros de salida

dataobjectObligatorio
Result data for bulk upload operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload Private FileFORMBRICKS_UPLOAD_PRIVATE_FILEAcción

Tool to obtain S3 presigned upload data for a private survey file. Use after confirming environmentId and surveyId.

Parámetros de entrada

fileNamestringObligatorio
Name of the file to upload (including extension), e.g., 'report.pdf'.
fileTypestringObligatorio
MIME type of the file, e.g., 'application/pdf'.
surveyIdstringObligatorio
The ID of the survey associated with the file.
environmentIdstringObligatorio
Environment ID of the Formbricks instance.

Parámetros de salida

dataobjectObligatorio
Presigned upload data object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload Public FileFORMBRICKS_UPLOAD_PUBLIC_FILEAcción

Tool to get S3 presigned data for uploading a public file. Use after environment creation to retrieve upload details.

Parámetros de entrada

fileNamestringObligatorio
Name of the file to be uploaded (including extension)
fileTypestringObligatorio
MIME type of the file (e.g., 'image/png')
environmentIdstringObligatorio
The environment ID where the file will be uploaded
allowedFileExtensionsstring[]
Optional list of allowed file extensions (without dot). If omitted, default allowed extensions apply.

Parámetros de salida

dataobjectObligatorio
Data returned containing URLs and form fields for file upload.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not