mirror of
https://github.com/formbricks/formbricks.git
synced 2026-02-13 19:29:17 -06:00
docs: updated screenshots in docs (#6562)
This commit is contained in:
Piyush Gupta
@@ -74,7 +74,6 @@
|
||||
"xm-and-surveys/surveys/general-features/multi-language-surveys",
|
||||
"xm-and-surveys/surveys/general-features/partial-submissions",
|
||||
"xm-and-surveys/surveys/general-features/recall",
|
||||
"xm-and-surveys/surveys/general-features/schedule-start-end-dates",
|
||||
"xm-and-surveys/surveys/general-features/metadata",
|
||||
"xm-and-surveys/surveys/general-features/variables",
|
||||
"xm-and-surveys/surveys/general-features/hide-back-button",
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 101 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 119 KiB |
@@ -6,12 +6,14 @@ description: "A step-by-step guide to integrate Airtable with Formbricks Cloud."
|
||||
The Airtable integration allows you to automatically send responses to an Airtable of your choice.
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow
|
||||
the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted
|
||||
instance.
|
||||
</Note>
|
||||
|
||||
## Formbricks Cloud
|
||||
|
||||
1. Go to the Integrations tab in your [Formbricks Cloud dashboard](https://app.formbricks.com/) and click on the "Connect" button under Airtable integration.
|
||||
1. Click on the `Configuration` tab in the left sidebar and then click on the `Integrations` tab and click on the `connect` button under the `Airtable` card.
|
||||
|
||||
|
||||
|
||||
@@ -28,7 +30,8 @@ The Airtable integration allows you to automatically send responses to an Airtab
|
||||
|
||||
|
||||
<Note>
|
||||
Before the next step, make sure that you have a Formbricks Survey with at least one question and a Airtable base with atleast one table in the Airtable account you integrated.
|
||||
Before the next step, make sure that you have a Formbricks Survey with at least one question and a Airtable
|
||||
base with atleast one table in the Airtable account you integrated.
|
||||
</Note>
|
||||
|
||||
1. Now click on the "Link New Table" button to link an Airtable with Formbricks and a modal will open up.
|
||||
@@ -61,4 +64,4 @@ To remove the integration with Airtable,
|
||||
|
||||
|
||||
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
title: "Google Sheets"
|
||||
description:
|
||||
"The Google Sheets integration allows you to automatically send responses to a Google Sheet of your choice."
|
||||
description: "The Google Sheets integration allows you to automatically send responses to a Google Sheet of your choice."
|
||||
---
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow
|
||||
the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted
|
||||
instance.
|
||||
</Note>
|
||||
|
||||
## Connect Google Sheets
|
||||
|
||||
1. Go to the Integrations tab in your [Formbricks Cloud dashboard](https://app.formbricks.com/) and click on the "Connect" button under Google Sheets integration.
|
||||
1. Click on the `Configuration` tab in the left sidebar and then click on the `Integrations` tab and click on the `connect` button under the `Google Sheets` card.
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +26,8 @@ description:
|
||||
|
||||
|
||||
<Note>
|
||||
Before the next step, make sure that you have a Formbricks Survey with at least one question and a Google Sheet in the Google account you integrated.
|
||||
Before the next step, make sure that you have a Formbricks Survey with at least one question and a Google
|
||||
Sheet in the Google account you integrated.
|
||||
</Note>
|
||||
|
||||
1. Now click on the "Link New Sheet" button to link a Google Sheet with Formbricks and a modal will open up.
|
||||
@@ -58,11 +60,11 @@ To remove the integration with Google Account,
|
||||
|
||||
## What info do you need?
|
||||
|
||||
* Your **Email ID** for authentication (We use this to identify you)
|
||||
- Your **Email ID** for authentication (We use this to identify you)
|
||||
|
||||
* Your **Google Sheets Names and IDs** (We fetch this to list and show you the options of choosing a sheet to integrate with)
|
||||
- Your **Google Sheets Names and IDs** (We fetch this to list and show you the options of choosing a sheet to integrate with)
|
||||
|
||||
* Write access to **selected Google Sheet** (The google sheet you choose to integrate it with, we write survey responses to it)
|
||||
- Write access to **selected Google Sheet** (The google sheet you choose to integrate it with, we write survey responses to it)
|
||||
|
||||
For the above, we ask for:
|
||||
|
||||
@@ -72,4 +74,4 @@ For the above, we ask for:
|
||||
|
||||
<Note>We store as little personal information as possible.</Note>
|
||||
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
title: "Notion"
|
||||
description:
|
||||
"The notion integration allows you to automatically send responses to a Notion database of your choice."
|
||||
description: "The notion integration allows you to automatically send responses to a Notion database of your choice."
|
||||
---
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow
|
||||
the guides [here](/self-hosting/configuration/integrations) to configure integrations on your self-hosted
|
||||
instance.
|
||||
</Note>
|
||||
|
||||
## Formbricks Cloud
|
||||
|
||||
1. Go to the Integrations tab in your [Formbricks Cloud dashboard](https://app.formbricks.com/) and click on the "Connect" button under Notion integration.
|
||||
1. Click on the `Configuration` tab in the left sidebar and then click on the `Integrations` tab and click on the `connect` button under the `Notion` card.
|
||||
|
||||
|
||||
|
||||
@@ -25,8 +26,8 @@ description:
|
||||
|
||||
|
||||
<Note>
|
||||
Before the next step, make sure that you have a Formbricks Survey with at
|
||||
least one question and a Notion database in the Notion account you integrated.
|
||||
Before the next step, make sure that you have a Formbricks Survey with at least one question and a Notion
|
||||
database in the Notion account you integrated.
|
||||
</Note>
|
||||
|
||||
1. Now click on the "Link New Database" button to link a Notion database with Formbricks and a modal will open up.
|
||||
@@ -57,17 +58,17 @@ Enabling the Notion Integration in a self-hosted environment requires a setup us
|
||||
|
||||
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`.
|
||||
- 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`
|
||||
- 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. A screen will appear which will have **Client ID** and **Client secret**. Copy them and set them as the environment variables in your Formbricks instance as:
|
||||
|
||||
* `NOTION_OAUTH_CLIENT_ID` - OAuth Client ID
|
||||
- `NOTION_OAUTH_CLIENT_ID` - OAuth Client ID
|
||||
|
||||
* `NOTION_OAUTH_CLIENT_SECRET` - OAuth Client Secret
|
||||
- `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 the [Formbricks Cloud](#formbricks-cloud) section to link a Notion database with Formbricks.
|
||||
|
||||
@@ -85,4 +86,4 @@ To remove the integration with Slack Workspace,
|
||||
|
||||
|
||||
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -10,7 +10,7 @@ description:
|
||||
|
||||
## Formbricks Cloud
|
||||
|
||||
1. Go to the Integrations tab in your [Formbricks Cloud dashboard](https://app.formbricks.com/) and click on the "Connect" button under Slack integration.
|
||||
1. Click on the `Configuration` tab in the left sidebar and then click on the `Integrations` tab and click on the `connect` button under the `Slack` card.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -22,9 +22,9 @@ You can create webhooks either through the **Formbricks App UI** or programmatic
|
||||
## **Creating Webhooks via UI**
|
||||
|
||||
- **Log in to Formbricks**
|
||||
Navigate to the **Integrations** Tab after logging in.
|
||||
and click on the `Configuration` tab in the left sidebar and then click on the `Integrations` tab.
|
||||
|
||||
|
||||
|
||||
|
||||
- Click on **Manage Webhooks** & then **Add Webhook** button:
|
||||
|
||||
@@ -58,133 +58,130 @@ Example of Response Created webhook payload:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"webhookId": "webhookId",
|
||||
"event": "responseCreated",
|
||||
"data": {
|
||||
"id": "responseId",
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"updatedAt": "2025-07-24T07:47:29.507Z",
|
||||
"surveyId": "surveyId",
|
||||
"displayId": "displayId",
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"finished": false,
|
||||
"endingId": null,
|
||||
"data": {
|
||||
"q1": "clicked"
|
||||
},
|
||||
"variables": {},
|
||||
"ttc": {
|
||||
"q1": 2154.700000047684
|
||||
},
|
||||
"tags": [],
|
||||
"meta": {
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"os": "macOS",
|
||||
"device": "desktop"
|
||||
},
|
||||
"country": "DE"
|
||||
},
|
||||
"singleUseId": null,
|
||||
"language": "en"
|
||||
{
|
||||
"data": {
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"data": {
|
||||
"q1": "clicked"
|
||||
},
|
||||
"displayId": "displayId",
|
||||
"endingId": null,
|
||||
"finished": false,
|
||||
"id": "responseId",
|
||||
"language": "en",
|
||||
"meta": {
|
||||
"country": "DE",
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"device": "desktop",
|
||||
"os": "macOS"
|
||||
}
|
||||
}
|
||||
},
|
||||
"singleUseId": null,
|
||||
"surveyId": "surveyId",
|
||||
"tags": [],
|
||||
"ttc": {
|
||||
"q1": 2154.700000047684
|
||||
},
|
||||
"updatedAt": "2025-07-24T07:47:29.507Z",
|
||||
"variables": {}
|
||||
},
|
||||
"event": "responseCreated",
|
||||
"webhookId": "webhookId"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Response Updated
|
||||
|
||||
Example of Response Updated webhook payload:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"webhookId": "webhookId",
|
||||
"event": "responseUpdated",
|
||||
"data": {
|
||||
"id": "responseId",
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"updatedAt": "2025-07-24T07:47:33.696Z",
|
||||
"surveyId": "surveyId",
|
||||
"displayId": "displayId",
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"finished": false,
|
||||
"endingId": null,
|
||||
"data": {
|
||||
"q1": "clicked",
|
||||
"q2": "Just browsing"
|
||||
},
|
||||
"variables": {},
|
||||
"ttc": {
|
||||
"q1": 2154.700000047684,
|
||||
"q2": 3855.799999952316
|
||||
},
|
||||
"tags": [],
|
||||
"meta": {
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"os": "macOS",
|
||||
"device": "desktop"
|
||||
},
|
||||
"country": "DE"
|
||||
},
|
||||
"singleUseId": null,
|
||||
"language": "en"
|
||||
{
|
||||
"data": {
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"data": {
|
||||
"q1": "clicked",
|
||||
"q2": "Just browsing"
|
||||
},
|
||||
"displayId": "displayId",
|
||||
"endingId": null,
|
||||
"finished": false,
|
||||
"id": "responseId",
|
||||
"language": "en",
|
||||
"meta": {
|
||||
"country": "DE",
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"device": "desktop",
|
||||
"os": "macOS"
|
||||
}
|
||||
}
|
||||
},
|
||||
"singleUseId": null,
|
||||
"surveyId": "surveyId",
|
||||
"tags": [],
|
||||
"ttc": {
|
||||
"q1": 2154.700000047684,
|
||||
"q2": 3855.799999952316
|
||||
},
|
||||
"updatedAt": "2025-07-24T07:47:33.696Z",
|
||||
"variables": {}
|
||||
},
|
||||
"event": "responseUpdated",
|
||||
"webhookId": "webhookId"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
### Response Finished
|
||||
|
||||
Example of Response Finished webhook payload:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"webhookId": "webhookId",
|
||||
"event": "responseFinished",
|
||||
"data": {
|
||||
"id": "responseId",
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"updatedAt": "2025-07-24T07:47:56.116Z",
|
||||
"surveyId": "surveyId",
|
||||
"displayId": "displayId",
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"finished": true,
|
||||
"endingId": "endingId",
|
||||
"data": {
|
||||
"q1": "clicked",
|
||||
"q2": "accepted"
|
||||
},
|
||||
"variables": {},
|
||||
"ttc": {
|
||||
"_total": 4947.899999035763,
|
||||
"q1": 2154.700000047684,
|
||||
"q2": 2793.199999988079
|
||||
},
|
||||
"tags": [],
|
||||
"meta": {
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"os": "macOS",
|
||||
"device": "desktop"
|
||||
},
|
||||
"country": "DE"
|
||||
},
|
||||
"singleUseId": null,
|
||||
"language": "en"
|
||||
{
|
||||
"data": {
|
||||
"contact": null,
|
||||
"contactAttributes": null,
|
||||
"createdAt": "2025-07-24T07:47:29.507Z",
|
||||
"data": {
|
||||
"q1": "clicked",
|
||||
"q2": "accepted"
|
||||
},
|
||||
"displayId": "displayId",
|
||||
"endingId": "endingId",
|
||||
"finished": true,
|
||||
"id": "responseId",
|
||||
"language": "en",
|
||||
"meta": {
|
||||
"country": "DE",
|
||||
"url": "https://app.formbricks.com/s/surveyId",
|
||||
"userAgent": {
|
||||
"browser": "Chrome",
|
||||
"device": "desktop",
|
||||
"os": "macOS"
|
||||
}
|
||||
}
|
||||
},
|
||||
"singleUseId": null,
|
||||
"surveyId": "surveyId",
|
||||
"tags": [],
|
||||
"ttc": {
|
||||
"_total": 4947.899999035763,
|
||||
"q1": 2154.700000047684,
|
||||
"q2": 2793.199999988079
|
||||
},
|
||||
"updatedAt": "2025-07-24T07:47:56.116Z",
|
||||
"variables": {}
|
||||
},
|
||||
"event": "responseFinished",
|
||||
"webhookId": "webhookId"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: "Wordpress"
|
||||
description:
|
||||
"Target specific visitors with a survey on your WordPress page using Formbricks for free. Show survey on specific page or on button click."
|
||||
description: "Target specific visitors with a survey on your WordPress page using Formbricks for free. Show survey on specific page or on button click."
|
||||
---
|
||||
|
||||
To run a targeted survey on your WordPress website, Formbricks is the way to go! 
|
||||
@@ -36,7 +35,7 @@ When you see this screen, you’re there:
|
||||
|
||||
## Step 3: Find and copy the environmentId
|
||||
|
||||
Go to Settings > Setup Checklist where you’ll find your environmentId:
|
||||
Go to `Configuration` > `Website & App Connection` where you’ll find your environmentId:
|
||||
|
||||
|
||||
|
||||
@@ -80,4 +79,4 @@ You did it! Reload the WordPress page and your survey should appear!
|
||||
|
||||
## Doesn't work?
|
||||
|
||||
If you have any questions or need help, feel free to reach out to us on [Github Discussions](https://github.com/formbricks/formbricks/discussions)
|
||||
If you have any questions or need help, feel free to reach out to us on [Github Discussions](https://github.com/formbricks/formbricks/discussions)
|
||||
|
||||
@@ -9,10 +9,10 @@ Add new members to your Formbricks organization to collaborate on surveys and ma
|
||||
## Prerequisites
|
||||
|
||||
To invite members, you need:
|
||||
|
||||
- **Owner** or **Manager** role in the organization
|
||||
- Valid email addresses for the people you want to invite
|
||||
|
||||
|
||||
## Individual invitations
|
||||
|
||||
Use this method when inviting a few people or when you need to carefully control each invitation.
|
||||
@@ -22,18 +22,21 @@ Use this method when inviting a few people or when you need to carefully control
|
||||
<Steps>
|
||||
<Step title="Navigate to Organization Settings > Access Control">
|
||||
Go to the organization settings page and click on the "Access Control" tab.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Start the invitation process">
|
||||
Click on the `Add member` button:
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Fill in member details">
|
||||
In the modal, add the Name, Email and Role of the organization member you want to invite:
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Send the invitation">
|
||||
@@ -62,12 +65,14 @@ Use bulk invitations when you need to invite many people at once, such as when o
|
||||
Click on the `Add member` button:
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Switch to bulk invite">
|
||||
In the modal, switch to `Bulk Invite`. You can download an example .CSV file to fill in the Name, Email and Role of the organization members you want to invite:
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Prepare your CSV file">
|
||||
@@ -99,6 +104,7 @@ Use bulk invitations when you need to invite many people at once, such as when o
|
||||
### Invitation status
|
||||
|
||||
Monitor the status of your invitations:
|
||||
|
||||
- **Pending**: Invitation sent but not yet accepted
|
||||
- **Accepted**: User has joined the organization
|
||||
- **Expired**: Invitation has expired and needs to be resent
|
||||
- **Expired**: Invitation has expired and needs to be resent
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
title: "Schedule Start & End Dates"
|
||||
description: "Optimize your survey management with custom Start & End Conditions in Formbricks. This feature allows you to control exactly when your survey is available for responses and when it should close, making it ideal for time-sensitive or number-of-response-limited surveys."
|
||||
icon: "calendar-days"
|
||||
---
|
||||
|
||||
Configure your surveys to open and close based on specific criteria. Here’s how to set up these conditions:
|
||||
|
||||
## **Schedule a Survey Release**
|
||||
|
||||
- **How to**: Open the Survey Editor, switch to the Settings tab. Scroll down to Response Options, Toggle the “Release Survey on Date”.
|
||||
|
||||
|
||||
|
||||
- **Details**: Choose the date and time when the survey should become available to respondents. All times follow UTC timezone.
|
||||
|
||||
- **Use Case**: This is useful for launching surveys in alignment with events, product releases, or specific marketing campaigns.
|
||||
|
||||
## **Automatically Closing a Survey**
|
||||
|
||||
- **How to**: Open the Survey Editor, switch to the Settings tab. Scroll down to Response Options, Toggle the “Close survey on date”.
|
||||
|
||||
|
||||
|
||||
- **Details**: Define a specific date and time for the survey to close. This also follows UTC timezone. 
|
||||
|
||||
- **Use Case**: Essential for surveys linked to time-bound events or studies where data collection needs to end
|
||||
at a specific point.
|
||||
|
||||
### **Summary**
|
||||
|
||||
Setting up Start & End Dates in Formbricks allows you to control the availability and duration of your surveys with precision. Whether you are conducting academic research, market analysis, or gathering event feedback, these settings help ensure that your data collection aligns perfectly with your objectives.
|
||||
|
||||
---
|
||||
@@ -60,7 +60,7 @@ Formbricks offers an intuitive No-Code interface that allows you to configure ac
|
||||
</Note>
|
||||
|
||||
<Steps>
|
||||
<Step title="Visit the Actions tab via the main navigation">
|
||||
<Step title="Visit the Configuration tab and click on the `Website & App Connection`">
|
||||
|
||||
</Step>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user