Integrations

Overview

We have step-by-step guides to configure our third-party integrations with a self hosted Formbricks instance. We currently support the below integrations, click on them to see their individual guides:

• Airtable
• Google Sheets
• Notion
• Make: We do not support Make.com for Self-hosted instances yet! Please follow our Cloud guide here
• n8n
• Slack
• [Wordpress]: Wordpress setup is similar to steps mentioned in Cloud here, just change the API Host to your self-hosted URL.
• Zapier

Step by Step Guides

Airtable

Enabling the Airtable Integration in a self-hosted environment requires creating an airtable account and changing the environment variables of your Formbricks instance.

1. Go to the Airtable and create a new account if you dont already have one.

2. Click on user icon on top left and open to Developer hub

3. Navigate to OAuth integrations and click on Register an OAuth integrations

3. Select a name for you integration and also add a redirect URL which will be <YOUR_WEBAPP_URL>/api/v1/integrations/airtable/callback

   

4. Now fill some basic details about your integrations and then go to scope section. You need to enable 5 scopes:

   • data.records:read
   • data.records:write
   • schema.bases:read
   • schema.bases:write
   • user.email:read

5. Click on the "Save" button and you are done
6. Now just copy Client ID and Redirect URL for your integration & add it to your Formbricks environment variables as in the docker compose file:

• AIRTABLE_CLIENT_ID
• AIRTABLE_REDIRECT_URL

Voila! You have successfully enabled the Airtable integration in your self-hosted Formbricks instance. Now you can follow the steps mentioned in Airtable Integration with Formbricks section to link an Airtable with Formbricks.

Google Sheets

Integrating Google Sheets with a self-hosted Formbricks instance requires configuring Google Cloud and updating your environment variables.

1. Go to the Google Cloud Console and create a new project.
2. Enable necessary APIs:
   • Now select the project you just created and go to the APIs & Services section.
   • Click on the Enable APIs and Services button and search for Google Sheets API & Google Drive API and enable it.
3. Configure OAuth Consent Screen:
   • Go to OAuth Consent screen and select the appropriate User Type (External or Internal). Select Internal if you want only the users of your Google Workspace to be able to use the integration.
   • Fill the required details:
     • App name: Name displayed during OAuth authentication.
     • User support email and Developer contact information: Your contact details for support.
   • Click on Save and Continue.
4. Add required Scopes:

• Click on the Add or Remove Scopes button and add the scopes:
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/drive
• Click on the Update button. Verify the scopes and click on the Save and Continue button.
• Skip the Test Users section and click on the Save and Continue button.

1. View the OAuth Consent Screen summary and click on the Back to Dashboard button.
2. Register OAuth Client:

• Navigate to Credentials > Create Credentials > OAuth Client ID.
• Select Web Application and set:
  • Name: Name of the OAuth Client ID.
  • Authorized JavaScript Origins: https://<your-public-facing-url>
  • Authorized redirect URIs: https://<your-public-facing-url>/api/google-sheet/callback
• Save and note the Client ID and Client Secret.

1. Copy the Client ID and Client Secret and set them as environment variables in your Formbricks instance:
   • GOOGLE_SHEETS_CLIENT_ID
   • GOOGLE_SHEETS_CLIENT_SECRET
   • GOOGLE_SHEETS_REDIRECT_URL
2. Enable Google Drive API:
   • Go to the APIs & Services section and click on the Enable APIs and Services button.
   • Search for Google Drive API and enable it.

Now just copy GOOGLE_SHEETS_CLIENT_ID, GOOGLE_SHEETS_CLIENT_SECRET and GOOGLE_SHEETS_REDIRECT_URL for your integration & add it to your Formbricks environment variables as in the docker compose file:

• GOOGLE_SHEETS_CLIENT_ID
• GOOGLE_SHEETS_CLIENT_SECRET
• GOOGLE_SHEETS_REDIRECT_URL

Voila! You have successfully enabled the Google Sheets integration in your self-hosted Formbricks instance. Now you can follow the steps mentioned in Google Sheets Integration with Formbricks section to link a Google Sheet with Formbricks.

Notion:

Enabling the Notion Integration in a self-hosted environment requires a setup using Notion account and changing the environment variables of your Formbricks instance.

1. Sign up for a Notion account, if you don't have one already.
2. Go to the my integrations page and click on New integration.
3. Fill up the basic information like Name, Logo and click on Submit.
4. Now, click on Distribution tab on the sidebar. A text will appear which will ask you to make the integration public. Click on that toggle button. A form will appear below the text.
5. Now provide it the details such as requested. Under Redirect URIs field:
   • If you are running formbricks locally, you can enter http://localhost:3000/api/v1/integrations/notion/callback.
   • Or, you can enter https://<your-public-facing-url>/api/v1/integrations/notion/callback
6. Once you've filled all the necessary details, click on Submit.
7. Now just copy from the screen the Client ID and Client secret for your integration & add it to your Formbricks environment variables as in the docker compose file:
   • NOTION_OAUTH_CLIENT_ID - OAuth Client ID
   • NOTION_OAUTH_CLIENT_SECRET - OAuth Client Secret

Voila! You have successfully enabled the Notion integration in your self-hosted Formbricks instance. Now you can follow the steps mentioned in Notion Integration with Formbricks section to link your Notion with Formbricks.

n8n

Enabling the n8n integration in a self-hosted environment requires a new workflow setup using n8n and changing the environment variables of your Formbricks instance.

1.Setup your n8n workflow: Go to n8n.io and create a new workflow. Search for “Formbricks” to get started:

2.Connect Formbricks with n8n: Now, you have to connect n8n with Formbricks via an API Key:

3. Click on Create New Credentail button to add your host and API Key

Now you need an API key. Please refer to the API Key Setup page to learn how to create one.

Once you copied it in the API Key field, hit Save button to test the connection and save the credentials.

4. Select Event: Next, you can choose the event you want to trigger the node on. You can select multiple events:

Here, we are adding Response Finished as an event, which will trigger when the survey has been filled out.

5. Select Survey: Next, you can choose from all the surveys you have created in this environment. You can select multiple surveys:

Here, we are selecting two surveys.

6. Test your trigger: In order to set up n8n you'll need a test response in the selected survey. This allows you to select the individual values of each response in your workflow. If you have Formbricks running locally and you want to set up an app survey, you can use our Demo App to trigger a survey and submit a response.

Next, click on Listen for event button.

Then, go to the survey which you selected. Fill it out, and wait for the particular event to trigger (in this case it's Response Finished). Once the event is triggered you will see the response that you filled out in the survey.

Now you have all the data you need at hand. The next steps depend on what you want to do with it. In this tutorial, we will send submissions to a discord channel:

7. Add discord to your workflow: Click on the plus and search Discord.

Fill in the Webhook URL and the Content that you want to receive in the respective discord channel. Next, click on Execute Node button to test the node.

Once the execution is successful, you'll receive the content in the discord channel.

Voila! You have successfully enabled the n8n integration in your self-hosted Formbricks instance. Now you can follow the steps mentioned in the Formbricks Integrations section to know more about the capabilities with Formbricks with n8n.

Slack

Enabling the Slack Integration in a self-hosted environment requires a setup using slack workspace account and changing the environment variables of your Formbricks instance.

1. Create a Slack workspace if you don't have one already.

2. Go to the Your apps page and Create New App.

3. Click on From Scratch and provide the App Name and select your workspace in Pick a workspace to develop your app in: dropdown. Click on Create App.

4. Go to the OAuth & Permissions tab on the sidebar and add the following Bot Token Scopes:

   • channels:read
   • chat:write
   • chat:write.public
   • chat:write.customize

5. Add the Redirect URLs under OAuth & Permissions tab. You can add the following URLs:

   • If you are running formbricks locally, you can enter https://localhost:3000/api/v1/integrations/slack/callback.
   • Or, you can enter https://<your-public-facing-url>/api/v1/integrations/slack/callback

6. Now, click on Install to Workspace and Allow the permissions.

7. Go to the Basic Information tab on the sidebar and copy the Client ID and Client Secret. Copy them & add it to your Formbricks environment variables as in the docker compose file:

• SLACK_CLIENT_ID - OAuth Client ID
• SLACK_CLIENT_SECRET - OAuth Client Secret

8. Now, you need to enable the public distribution of your app. Go to the Basic Information tab and click on the Manage distribution button and click on the "Distribute App".
9. Scroll down to the Share your app with other workspaces section, complete the checklist and click on the Activate public distribution button.

Voila! You have successfully enabled the Slack integration in your self-hosted Formbricks instance. Now you can follow the steps mentioned in the Slack Integration section to link a Slack workspace with Formbricks.

Zapier

1. Setup your Zap: Go to zapier.com and create a new Zap. Search for “Formbricks” to get started:

Then, choose the event you want to trigger the Zap on:

1. Connect Formbricks with Zapier: You have to connect Zapier with Formbricks via an API Key:

Now you need an API key. Please refer to the API Key Setup page to learn how to create one.

Once you copied it in the newly opened Zapier window, you will be connected:

Voila! You have successfully configured Zapier to work with your self-hosted Formbricks instance. Now you can follow the steps mentioned in the Zapier Integration section to connect it with your Formbricks app and see it live.