The Formbricks connector lets your AI agent act in each user's Formbricks account. Each user connects their own Formbricks API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 34 tools.
- Tools
- 34
- What they doRead · write · destructive
- 18 · 11 · 518 read11 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Formbricks connection
In AgentKit > Connections, create a Formbricks connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'formbricks'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Formbricks:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'formbricks_action_classes_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "formbricks"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Formbricks:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="formbricks_action_classes_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Formbricks credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolformbricks_action_class_getGet one action class.Read-onlyGet Action Class
Get one action class. Get the ID from formbricks_action_classes_list.
Inputs
action_class_idstringrequired- Action Class ID. Example: clz4t5u6v0004abcd7890uvwx
formbricks_action_classes_listList the actions (code or no-code events) that can trigger app surveys.Read-onlyList Action Classes
List the actions (code or no-code events) that can trigger app surveys. Use formbricks_action_class_create to add one.
Inputs
This tool takes no inputs.
formbricks_contact_attribute_key_getGet one contact attribute key.Read-onlyGet Contact Attribute Key
Get one contact attribute key. Returns id, createdAt, updatedAt, isUnique, key, name, description, type, workspaceId, environmentId. Get the ID from formbricks_contact_attribute_keys_list.
Inputs
idstringrequired- The ID of the contact attribute key. Example: clz8w9x0y0005abcd1234yzab
formbricks_contact_attribute_keys_listList the contact attribute keys (attribute definitions) in a workspace.Read-onlyList Contact Attribute Keys
List the contact attribute keys (attribute definitions) in a workspace. Returns data (a list of records with id, createdAt, updatedAt, isUnique, key, name, description, type, workspaceId, environmentId). Use this before formbricks_contact_create to check which keys exist.
Inputs
end_datestring- End date. Example: 2026-01-31T23:59:59.000Z
filter_date_fieldstring- Date field to filter by. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt limitnumber- Number of items to return. Example: 50
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc skipnumber- Number of items to skip. Example: 0
sort_bystring- Sort by field. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt start_datestring- Start date. Example: 2026-01-01T00:00:00.000Z
workspace_idstring- The Workspace ID to filter by. Example: clx9k2m3n0000abcd1234efgh
formbricks_contact_attributes_listList contact attribute values in the workspaces the key can access.Read-onlyList Contact Attributes
List contact attribute values in the workspaces the key can access. Use formbricks_contact_attribute_keys_list for the attribute definitions.
Inputs
This tool takes no inputs.
formbricks_contact_getGet one contact with its attributes.Read-onlyGet Contact
Get one contact with its attributes. Get the contact ID from formbricks_contacts_list.
Inputs
contact_idstringrequired- The ID of the contact to retrieve. Example: clz7d8e9f0002abcd9012mnop
formbricks_contacts_listList the contacts in the workspaces the key can access.Read-onlyList Contacts
List the contacts in the workspaces the key can access. Use formbricks_contact_get for one contact's attributes.
Inputs
This tool takes no inputs.
formbricks_me_getGet the workspaces and organization the API key can access, with its permission level per workspace.Read-onlyGet API Key Info
Get the workspaces and organization the API key can access, with its permission level per workspace. Returns organizationId, organizationAccess, workspaces, environments. Use this first to get workspace IDs.
Inputs
This tool takes no inputs.
formbricks_response_getGet one survey response with its answers, metadata and variables.Read-onlyGet Response
Get one survey response with its answers, metadata and variables. Returns id, createdAt, updatedAt, finished, surveyId, contactId, endingId, data, variables, ttc. Get the ID from formbricks_responses_list.
Inputs
idstringrequired- The ID of the response. Example: clz8w9x0y0005abcd1234yzab
formbricks_responses_listList survey responses, optionally for one survey or contact and within a date range.Read-onlyList Responses
List survey responses, optionally for one survey or contact and within a date range. Returns data (a list of records with id, createdAt, updatedAt, finished, surveyId, contactId, endingId, data, variables, ttc). Use formbricks_response_get for one response.
Inputs
contact_idstring- Contact ID. Example: clz7d8e9f0002abcd9012mnop
end_datestring- End date. Example: 2026-01-31T23:59:59.000Z
filter_date_fieldstring- Date field to filter by. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt limitnumber- Number of items to return. Example: 50
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc skipnumber- Number of items to skip. Example: 0
sort_bystring- Sort by field. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt start_datestring- Start date. Example: 2026-01-01T00:00:00.000Z
survey_idstring- Survey ID. Example: cly1a2b3c0001abcd5678ijkl
formbricks_roles_listList the organization roles available in Formbricks.Read-onlyList Roles
List the organization roles available in Formbricks. Returns data (a list). Use this to see the roles that members can have.
Inputs
This tool takes no inputs.
formbricks_survey_contact_link_getGet a personalized survey link for one contact, optionally expiring after a number of days.Read-onlyGet Personalized Survey Link
Get a personalized survey link for one contact, optionally expiring after a number of days. Returns data (surveyUrl, expiresAt). Get survey IDs from formbricks_surveys_list.
Inputs
contact_idstringrequired- The ID of the contact. Example: clz7d8e9f0002abcd9012mnop
survey_idstringrequired- The ID of the survey. Example: cly1a2b3c0001abcd5678ijkl
expiration_daysinteger- Number of days until the generated JWT expires. If not provided, there is no expiration. Example: 30
formbricks_survey_getGet one survey with its questions, blocks, endings, status and display settings.Read-onlyGet Survey
Get one survey with its questions, blocks, endings, status and display settings. Get survey IDs from formbricks_surveys_list.
Inputs
survey_idstringrequired- Survey ID. Example: cly1a2b3c0001abcd5678ijkl
formbricks_survey_segment_links_listGenerate personalized survey links for every contact in a segment, with chosen attributes.Read-onlyList Segment Survey Links
Generate personalized survey links for every contact in a segment, with chosen attributes. Returns data (a list of records with contactId, surveyUrl, expiresAt, attributes). Get survey IDs from formbricks_surveys_list.
Inputs
segment_idstringrequired- The ID of the segment. Example: clz1q2r3s0003abcd3456qrst
survey_idstringrequired- The ID of the survey. Example: cly1a2b3c0001abcd5678ijkl
attribute_keysstring- Comma-separated list of contact attribute keys to include in the response. You can have max 20 keys. If not provided, no attributes will be included. Example: email,userId
expiration_daysnumber- Number of days until the generated JWT expires. If not provided, there is no expiration. Example: 30
limitnumber- Number of items to return. Example: 50
skipnumber- Number of items to skip. Example: 0
formbricks_survey_single_use_links_getGenerate single-use links for a link survey (each link accepts one response).Read-onlyGenerate Single-Use Links
Generate single-use links for a link survey (each link accepts one response). Single-use links must be enabled on the survey. Get survey IDs from formbricks_surveys_list.
Inputs
survey_idstringrequired- Survey ID. Example: cly1a2b3c0001abcd5678ijkl
limitinteger- Number of links to generate. Example: 50
formbricks_surveys_listList the surveys in the workspaces the key can access, with questions, status and settings.Read-onlyList Surveys
List the surveys in the workspaces the key can access, with questions, status and settings. Use this to get survey IDs. Use formbricks_survey_get for one survey.
Inputs
This tool takes no inputs.
formbricks_webhook_getGet one webhook.Read-onlyGet Webhook
Get one webhook. Returns id, name, createdAt, updatedAt, url, source, workspaceId, environmentId, triggers, surveyIds. Get the ID from formbricks_webhooks_list.
Inputs
idstringrequired- The ID of the webhook. Example: clz8w9x0y0005abcd1234yzab
formbricks_webhooks_listList webhooks, optionally for given surveys.Read-onlyList Webhooks
List webhooks, optionally for given surveys. Returns data (a list of records with id, name, createdAt, updatedAt, url, source, workspaceId, environmentId, triggers, surveyIds). Use formbricks_webhook_create to add one.
Inputs
end_datestring- End date. Example: 2026-01-31T23:59:59.000Z
filter_date_fieldstring- Date field to filter by. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt limitnumber- Number of items to return. Example: 50
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc skipnumber- Number of items to skip. Example: 0
sort_bystring- Sort by field. One of: createdAt, updatedAt. Example: createdAtone of
createdAtupdatedAt start_datestring- Start date. Example: 2026-01-01T00:00:00.000Z
survey_idsarray- Survey IDs. Example: ["cly1a2b3c0001abcd5678ijkl"]
formbricks_action_class_createCreate a code action (tracked by key from your app) or a no-code action (page view, click, exit intent) in a workspace.WriteCreate Action Class
Create a code action (tracked by key from your app) or a no-code action (page view, click, exit intent) in a workspace. Code actions need key; no-code actions need no_code_config. Get the workspace ID from formbricks_me_get.
Inputs
namestringrequired- Name of the action class. Example: NPS survey
typestringrequired- Type of action class. One of: code, noCode. Example: codeone of
codenoCode workspace_idstringrequired- The workspace ID where the action class will be created. Example: clx9k2m3n0000abcd1234efgh
descriptionstring- Optional description of the action class. Example: Customer's subscription tier
keystring- Required when type is 'code'. A unique identifier for the action. Not needed for 'noCode' type. Example: plan_tier
no_code_configobject- Configuration object required when type is 'noCode'. Defines the conditions for triggering the action. Not needed for 'code' type. Example: {"type": "click", "elementSelector": {"cssSelector": ".buy-button"}, "urlFilters": []}
formbricks_contact_attribute_key_createDefine a new contact attribute key in a workspace.WriteCreate Contact Attribute Key
Define a new contact attribute key in a workspace. Returns id, createdAt, updatedAt, isUnique, key, name, description, type, workspaceId, environmentId. Get the workspace ID from formbricks_me_get.
Inputs
descriptionstringrequired- Description of the attribute. Example: Customer's subscription tier
keystringrequired- The attribute identifier used in the system. Example: plan_tier
namestringrequired- Display name for the attribute. Example: NPS survey
workspace_idstringrequired- The ID of the Workspace this attribute belongs to. Example: clx9k2m3n0000abcd1234efgh
formbricks_contact_attribute_key_updateUpdate a contact attribute key's key, name and description.WriteUpdate Contact Attribute Key
Update a contact attribute key's key, name and description. Returns id, createdAt, updatedAt, isUnique, key, name, description, type, workspaceId, environmentId. Get the ID from formbricks_contact_attribute_keys_list.
- Idempotent
Inputs
descriptionstringrequired- Description of the attribute. Example: Customer's subscription tier
idstringrequired- The ID of the contact attribute key. Example: clz8w9x0y0005abcd1234yzab
keystringrequired- The attribute identifier used in the system. Example: plan_tier
namestringrequired- Display name for the attribute. Example: NPS survey
formbricks_contact_createCreate one contact in a workspace from an attributes object that includes a valid email.WriteCreate Contact
Create one contact in a workspace from an attributes object that includes a valid email. Returns id, createdAt, workspaceId, environmentId, attributes. Every attribute key must already exist; create new keys with formbricks_contact_attribute_key_create. Use formbricks_contacts_bulk_upload for many contacts. Get the workspace ID from formbricks_me_get.
Inputs
attributesobjectrequired- Attributes. Example: {"email": "jane@example.com", "userId": "user-123"}
workspace_idstringrequired- Workspace ID. Example: clx9k2m3n0000abcd1234efgh
formbricks_contacts_bulk_uploadCreate or update many contacts at once.WriteUpload Contacts in Bulk
Create or update many contacts at once. Each contact carries a list of attributeKey and value pairs. Returns data (status, message). Use formbricks_contact_create for one contact. Get the workspace ID from formbricks_me_get.
- Idempotent
Inputs
contactsarrayrequired- Contacts. Example: [{"attributes": [{"attributeKey": {"key": "email", "name": "Email"}, "value": "jane@example.com"}]}]
workspace_idstringrequired- Workspace ID. Example: clx9k2m3n0000abcd1234efgh
formbricks_response_createRecord a survey response.WriteCreate Response
Record a survey response. This runs the response pipeline (webhooks, integrations and follow-up emails). Returns id, createdAt, updatedAt, finished, surveyId, contactId, endingId, data, variables, ttc. Use this to import responses collected elsewhere. Get survey IDs from formbricks_surveys_list.
Inputs
dataobjectrequired- The data of the response. Example: {"q1": "Great product"}
finishedbooleanrequired- Whether the response is finished. Example: true
survey_idstringrequired- The ID of the survey. Example: cly1a2b3c0001abcd5678ijkl
ending_idstring- The ID of the ending. Example: ending-1
languagestring- The language of the response. Example: en
single_use_idstring- The single use ID of the response. Example: abc123
user_idstring- User ID. Example: user-123
variablesobject- The variables of the response. Example: {}
formbricks_response_updateUpdate a response's answers, finished flag, ending, variables or language.WriteUpdate Response
Update a response's answers, finished flag, ending, variables or language. This runs the response pipeline. Returns id, createdAt, updatedAt, finished, surveyId, contactId, endingId, data, variables, ttc. Get the ID from formbricks_responses_list.
- Idempotent
Inputs
idstringrequired- The ID of the response. Example: clz8w9x0y0005abcd1234yzab
dataobject- Data. Example: {"q1": "Great product"}
ending_idstring- Ending ID. Example: ending-1
finishedboolean- Finished. Example: true
languagestring- Language. Example: en
variablesobject- Variables. Example: {}
formbricks_survey_createCreate a link or app survey in a workspace with a name, status, display option, languages and questions.WriteCreate Survey
Create a link or app survey in a workspace with a name, status, display option, languages and questions. Building questions in the Formbricks editor is easier; use this for templated surveys. Get the workspace ID from formbricks_me_get.
Inputs
namestringrequired- Name. Example: NPS survey
statusstringrequired- Status. One of: draft, inProgress, paused, completed. Example: draftone of
draftinProgresspausedcompleted typestringrequired- Type. One of: link, app. Example: linkone of
linkapp workspace_idstringrequired- Workspace ID. Example: clx9k2m3n0000abcd1234efgh
display_optionstring- Display Option. One of: displayOnce, displayMultiple, respondMultiple, displaySome. Example: displayOnceone of
displayOncedisplayMultiplerespondMultipledisplaySome languagesarray- Languages. Example: []
questionsarray- Questions. Example: []
formbricks_survey_updateUpdate a survey's properties, such as its name, status, questions or display settings.WriteUpdate Survey
Update a survey's properties, such as its name, status, questions or display settings. Fields not sent are kept. Get survey IDs from formbricks_surveys_list.
- Idempotent
Inputs
surveyobjectrequired- Survey fields to change, as a JSON object using Formbricks survey property names (name, status, displayOption, questions, welcomeCard, endings and so on). Example: {"name": "NPS survey (Q1)", "status": "paused"}
survey_idstringrequired- Survey ID. Example: cly1a2b3c0001abcd5678ijkl
formbricks_webhook_createCreate a webhook that posts survey events (responseCreated, responseUpdated, responseFinished) to a URL.WriteCreate Webhook
Create a webhook that posts survey events (responseCreated, responseUpdated, responseFinished) to a URL. Returns id, name, createdAt, updatedAt, url, source, workspaceId, environmentId, triggers, surveyIds. Pass an empty survey_ids list for all surveys. Get the workspace ID from formbricks_me_get.
Inputs
namestringrequired- The name of the webhook. Example: NPS survey
sourcestringrequired- The source of the webhook. One of: user, zapier, make, n8n. Example: userone of
userzapiermaken8n survey_idsarrayrequired- The IDs of the surveys. Example: ["cly1a2b3c0001abcd5678ijkl"]
triggersarrayrequired- The triggers of the webhook. Example: ["responseFinished"]
urlstringrequired- The URL of the webhook. Example: https://example.com/webhooks/formbricks
workspace_idstringrequired- The ID of the Workspace. Example: clx9k2m3n0000abcd1234efgh
formbricks_webhook_updateReplace a webhook's name, URL, source, triggers and surveys.WriteUpdate Webhook
Replace a webhook's name, URL, source, triggers and surveys. Returns id, name, createdAt, updatedAt, url, source, workspaceId, environmentId, triggers, surveyIds. Send all required fields. Get the ID from formbricks_webhooks_list.
- Idempotent
Inputs
idstringrequired- The ID of the webhook. Example: clz8w9x0y0005abcd1234yzab
namestringrequired- The name of the webhook. Example: NPS survey
sourcestringrequired- The source of the webhook. One of: user, zapier, make, n8n. Example: userone of
userzapiermaken8n survey_idsarrayrequired- The IDs of the surveys. Example: ["cly1a2b3c0001abcd5678ijkl"]
triggersarrayrequired- The triggers of the webhook. Example: ["responseFinished"]
urlstringrequired- The URL of the webhook. Example: https://example.com/webhooks/formbricks
workspace_idstringrequired- The ID of the Workspace. Example: clx9k2m3n0000abcd1234efgh
formbricks_action_class_deleteDelete an action class.DestructiveDelete Action Class
Delete an action class. Get the ID from formbricks_action_classes_list.
- Idempotent
Inputs
action_class_idstringrequired- Action Class ID. Example: clz4t5u6v0004abcd7890uvwx
formbricks_contact_attribute_key_deleteDelete a contact attribute key and its values.DestructiveDelete Contact Attribute Key
Delete a contact attribute key and its values. Returns id, createdAt, updatedAt, isUnique, key, name, description, type, workspaceId, environmentId. Get the ID from formbricks_contact_attribute_keys_list.
- Idempotent
Inputs
idstringrequired- The ID of the contact attribute key. Example: clz8w9x0y0005abcd1234yzab
formbricks_response_deleteDelete a survey response.DestructiveDelete Response
Delete a survey response. Returns id, createdAt, updatedAt, finished, surveyId, contactId, endingId, data, variables, ttc. Get the ID from formbricks_responses_list.
- Idempotent
Inputs
idstringrequired- The ID of the response. Example: clz8w9x0y0005abcd1234yzab
formbricks_survey_deleteDelete a survey and its responses.DestructiveDelete Survey
Delete a survey and its responses. Get survey IDs from formbricks_surveys_list.
- Idempotent
Inputs
survey_idstringrequired- Survey ID. Example: cly1a2b3c0001abcd5678ijkl
formbricks_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook. Returns id, name, createdAt, updatedAt, url, source, workspaceId, environmentId, triggers, surveyIds. Get the ID from formbricks_webhooks_list.
- Idempotent
Inputs
idstringrequired- The ID of the webhook. Example: clz8w9x0y0005abcd1234yzab
No tools match.