Compare commits

...

492 Commits

Author SHA1 Message Date
Matti Nannt
e1eba78cf1 chore: Version Packages (#1126)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-10-13 13:02:48 +00:00
dependabot[bot]
417ee07a0b chore(deps): bump webpack from 5.75.0 to 5.88.2 (#1121)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-13 12:29:57 +00:00
Matti Nannt
e46b058842 chore: Prepare release of formbricks-js 1.1.0 (#1124) 2023-10-13 12:19:16 +00:00
Matti Nannt
7078101de9 feat: move formbricks-js to vite bundler (#883)
Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com>
2023-10-13 10:28:25 +00:00
Johannes
58a6c1be41 lp: update leaderboard Friday 13th (#1116) 2023-10-12 20:50:44 +00:00
Bilal Mirza
3206794055 fix: Buttons Margin and code snippets issue across Docs (#1107) 2023-10-12 07:56:58 +00:00
Shivam Bhatnagar
8a94f9437e fix(formbricks-com): fix horizontal scrollbar in small viewports (#1100) 2023-10-12 06:53:14 +00:00
KRISH SONI
bb35b8d79f chore: add nodejs URL in readme (#1102) 2023-10-12 06:31:30 +00:00
Rohan Gupta
b9d6134d22 fix: survey baseurl fix and addition of SHORT_SURVEY_BASE_URL in .env.example file (#1046)
Co-authored-by: Rohan Gupta <rohan.gupta@zopper.com>
2023-10-12 06:15:52 +00:00
Matti Nannt
8c9a9d670b fix: readme formtribe link (#1099) 2023-10-11 17:06:33 +00:00
Matti Nannt
61aaf301c1 fix: web-app surveys not triggered with modified api endpoint (#1097) 2023-10-11 16:48:54 +00:00
Rotimi Best
2f8aa9b2ae fix: format survey date fields back to Date type (#1096) 2023-10-11 15:25:09 +00:00
Dhruwang Jariwala
e2a6631b64 refactor: Move all @formbricks/ui components to the new folder structure (#1057)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-11 15:17:13 +00:00
Dhruwang Jariwala
7ff847c607 fix: scrollbar issue (#1090) 2023-10-11 11:52:13 +00:00
Johannes
501ce8cf78 lp: blog article community developed feature (#1091) 2023-10-11 11:14:11 +00:00
Anjy Gupta
068a440585 fix: add toast and error handler for multiple team/product creation with existing team/product name (#996)
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-11 09:45:51 +00:00
Anush Deokar
e79a75cf6a fix: X and optional text overlap (#1077)
Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
Co-authored-by: Dhruwang Jariwala <67850763+Dhruwang@users.noreply.github.com>
2023-10-11 09:35:23 +00:00
Shubham Palriwala
820680d7e7 feat: add docs for setting ENCRYPTION_KEY in .env in contributing guide (#1088)
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-11 09:24:28 +00:00
Piyush Gupta
311df18315 feat: brand color overwrite (#1035) 2023-10-11 08:46:34 +00:00
Dhruwang Jariwala
e7d95f9d75 fix: multiChoice undefined value check (#1087) 2023-10-11 08:45:33 +00:00
Anjy Gupta
b2d03b7284 fix: added script to setup encryption key in gitpod script (#1080) 2023-10-11 07:00:28 +00:00
Aditya Deshlahre
0d3b948a8b fix: Name can updated without any characters/value (#1020)
Co-authored-by: Shubham Palriwala <spalriwalau@gmail.com>
2023-10-11 06:52:00 +00:00
Deepanshu
04d8475df2 add FULL_STOP to Readme File (#1075) 2023-10-11 06:26:14 +00:00
Olasunkanmi Balogun
7d611d3ddf fix: statusText mismatch in webhook integrations (#1068)
Co-authored-by: Shubham Palriwala <spalriwalau@gmail.com>
2023-10-11 06:21:49 +00:00
Abhinav Arya
ad15af59da fix: image and page responsiveness in docs section (#1078)
Co-authored-by: Shubham Palriwala <spalriwalau@gmail.com>
2023-10-11 06:08:23 +00:00
Rotimi Best
9063c8286c chore: refactor services with Formbricks best practices (#988)
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-10 13:54:23 +00:00
Matti Nannt
cff23f497c fix: responses not visible when sdk not connected (#1074) 2023-10-10 12:11:19 +00:00
Matti Nannt
cb6c1aade6 fix: getAttributeClassByName cache returns wrong entries (#1072) 2023-10-10 11:52:47 +00:00
Anshuman Pandey
66408fdccc feat: 2FA (#798)
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-10 11:29:11 +00:00
Matti Nannt
459eb5525e chore: add ENCRYPTION_KEY to github actions (#1069) 2023-10-10 11:18:40 +00:00
Shubham Palriwala
b52adf0122 feat: authorization in attributeClassAction (#1056)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-10 10:51:00 +00:00
Prasoon Mahawar
6fb61f1bfd fix: Exit Intent now works on FF, Safari, Arc (#1059) 2023-10-10 16:02:41 +05:30
Shubham Palriwala
85fe1feec6 feat: add authorization in product update actions (#1060)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-10 12:08:26 +02:00
Matti Nannt
57390faef7 chore: update github build action (#1065) 2023-10-10 11:56:46 +02:00
Geri Máté
7210583bb5 chore: add dyrector.io to OSS friends (#1040) 2023-10-10 15:19:45 +05:30
Shubham Palriwala
767de5d011 feat: authorization in notificationUpdateAction (#1058) 2023-10-10 15:15:01 +05:30
Ikko Eltociear Ashimine
545945cd04 fix: typo in gdpr-guide.mdx (#1043) 2023-10-10 14:57:50 +05:30
Shubham Palriwala
395ff50ac6 feat: authorization in deletePerson action (#1063) 2023-10-10 14:32:56 +05:30
Shubham Palriwala
32449e6f69 feat: introduce new security policy (#1033) 2023-10-10 14:03:34 +05:30
Johannes
d7ffe17312 chore: Add FormTribe Hackathon to README (#1030) 2023-10-10 13:03:04 +05:30
Rohit Dadgal
c2c221b8fa chore: add punctuations in README (#1024) 2023-10-10 12:42:07 +05:30
Shubham Palriwala
a4909482ab fix: make pr.yml mandatory on all PRs (#1061) 2023-10-10 12:27:03 +05:30
Rohan Gupta
4ea7ac0a81 fix: Multi select Other option selected automatically when coming back & take final value onSubmit of other field (#1004)
Co-authored-by: Rohan Gupta <rohan.gupta@zopper.com>
2023-10-10 10:29:36 +05:30
Dhruwang Jariwala
6a280913c3 refactor: Unified single response card and improved UX (#750)
Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Dhruwang Jariwala <dhruwang@Dhruwangs-MacBook-Pro.local>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-09 23:22:09 +02:00
Matti Nannt
d84e06b909 fix: formbricks connection status display (#1041) 2023-10-09 17:46:18 +02:00
Johannes
0b90718e9f lp: add PH notifier to LP (#1034)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-09 17:11:06 +02:00
Shubham Palriwala
52ea908709 feat: add authorization on product update action during onboarding (#1009)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-09 16:31:19 +02:00
Rohan Gupta
d05122d2fe feat: auto prefilled prev ID when Question ID is left empty (#1038)
Co-authored-by: Rohan Gupta <rohan.gupta@zopper.com>
2023-10-09 15:48:56 +02:00
Shubham Palriwala
c3e50441cd feat: add authorization on google integrations actions (#1031)
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-09 14:51:02 +02:00
Matti Nannt
633704d96e fix: add cors to display update endpoint (#1036) 2023-10-09 14:12:08 +02:00
Aditya Deshlahre
631a50b733 fix: new team not listed in teams list in navbar (#1010)
Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com>
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-09 13:09:44 +02:00
Shubham Palriwala
f9fb2c6a99 fix: build error due to survey status becoming optional (#1026)
* fix: build error due to survey status becoming optional

* made refactors

* fix: use universal ID over newly created ID

* remove build step from github actions workflows

---------

Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
Co-authored-by: Matti Nannt <mail@matthiasnannt.com>
2023-10-09 12:44:01 +02:00
Anshuman Pandey
a08a6e4b41 fix: file uploads bug (#1027)
* fix: fixes file upload bug

* fix: updates docker compose
2023-10-09 08:03:09 +02:00
Ratish jain
7ba85e0d2b fix: TryNow CTA button UX (#1013)
* buttons responsiveness fixed

* fix: try now button ui
2023-10-09 10:06:14 +05:30
Abhinav Arya
e78e5a0289 fix: Responsiveness for the code table (#1018)
* fix Responsiveness for the code table

* fix Removing extra line
2023-10-09 10:00:29 +05:30
Johannes
c432e323ce fix: Smoothen full screen preview animation
fix: Smoothen full screen preview animation
2023-10-09 00:01:13 +05:30
Johannes
9bab070778 Merge branch 'main' into smooth-preview-animation 2023-10-08 23:59:10 +05:30
Johannes
fab187d83d chore: Redesign metadata
chore: Redesign metadata
2023-10-08 23:57:00 +05:30
Dhruwang
e3a18632db fixed shrink animation 2023-10-08 23:49:57 +05:30
Matthias Nannt
7d52ed19c0 combine migrations 2023-10-08 17:55:51 +02:00
Matti Nannt
cf99218544 Merge branch 'main' into redesign-metadata 2023-10-08 17:45:36 +02:00
Matti Nannt
524b73787a fix: optimize Github action PR check pipeline (#1019)
* fix: remove failing bundle analytics action

* rename building action

* reorder actions

* update naming of actions
2023-10-08 16:58:27 +02:00
Dhruwang
ea3f2fd7cd merged main 2023-10-08 19:40:17 +05:30
Dhruwang
4b9f21fbd0 Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-08 19:38:02 +05:30
Dhruwang
9614208fb9 made status optional and edited display update functionality 2023-10-08 19:36:42 +05:30
Johannes
89f0c0410e lp: update leader board 081023
lp: update leader board 081023
2023-10-08 19:18:30 +05:30
Johannes
cc17d9d560 update leaderboard 2023-10-08 19:15:27 +05:30
Johannes
5fc7643d39 fix: Required Condition Update for MultiSelectQuestion.
fix: Required Condition Update for MultiSelectQuestion.
2023-10-08 17:11:26 +05:30
Johannes
c923d91264 fix: Card on Landing Page overlapping issue #1001
fix: Card on Landing Page overlapping issue #1001
2023-10-08 16:41:12 +05:30
Johannes
35e3cdcd0d actually fix it ;) 2023-10-08 16:39:23 +05:30
Johannes
6ccbd559fb Reset env in demo app 2023-10-08 16:31:27 +05:30
Johannes
9b26ce5f38 Merge branch 'main' of github.com:formbricks/formbricks into itzabhinavarya/main 2023-10-08 16:29:57 +05:30
Dhruwang
93150b88b7 Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-08 16:28:47 +05:30
Dhruwang
4c3a17cdcc made expansion animation smoother 2023-10-08 16:24:39 +05:30
Naitik
b66c37cd26 Required Validator Update 2023-10-08 16:03:42 +05:30
Abhinav Arya
f9457b04f6 Fix overlapping card content on the website using tailwind based approach 2023-10-08 10:18:00 +00:00
Abhinav Arya
eca90dfd9a Fix overlapping card content on the website using tailwind based approach 2023-10-08 09:54:32 +00:00
Johannes
59acb761e2 feat: Validation for Number, URL, Email and Phone Number in Open Text Question
feat: Validation for Number, URL, Email and Phone Number in Open Text Question
2023-10-08 15:02:38 +05:30
Dhruwang
611fa814d4 Merge branch 'main' of https://github.com/Dhruwang/formbricks into KapadiaNaitik/main 2023-10-08 14:56:44 +05:30
Johannes
f181950cc0 Fix: Making navigation bar of LP responsive
Fix: Making navigation bar of LP responsive
2023-10-08 14:54:42 +05:30
Matthias Nannt
0dbf033f01 remove commented code 2023-10-08 11:07:07 +02:00
Johannes
ac4790c38a fix: form preview rerender on survey name change
fix: form preview rerender on survey name change
2023-10-08 14:02:48 +05:30
Johannes
8cfcf28a14 feat: add keyboard usability to end user survey experience
feat: add keyboard usability to end user survey experience
2023-10-08 13:37:02 +05:30
Johannes
53e3a80d6f fix unrelated React error 2023-10-08 13:35:40 +05:30
Dhruwang
c37d924c85 merged latest changes and fixed preview reredering issue 2023-10-08 13:35:29 +05:30
Johannes
07a0d669f4 Fix: Build error in full screen preview PR
Fix: Build error in full screen preview PR
2023-10-08 13:20:48 +05:30
Johannes
5a8bcd10e6 fix build error 2023-10-08 13:19:23 +05:30
Johannes
7c84f5807c feat: Add full screen preview feature to Survey Editor
feat: Add full screen preview feature to Survey Editor
2023-10-08 13:01:42 +05:30
Abhinav Arya
fbc16b3a72 Fix/Card overlapping issue #1001 2023-10-08 07:07:42 +00:00
Ayush
3af6498891 fix: rerender on name change 2023-10-08 08:39:37 +05:30
Yash
f6b4bbeeac fix#997 making navigation bar responsive 2023-10-07 21:26:28 +05:30
Johannes
66e6eaaabd Merge branch 'main' of github.com:formbricks/formbricks into feat/full-screen-link-survey-preview 2023-10-07 17:07:34 +05:45
Johannes
5426e400c9 docs: Added Single Use Links Section in Docs.
docs: Added Single Use Links Section in Docs.
2023-10-07 16:36:57 +05:45
Johannes
feed3e73c9 update single use docs page 2023-10-07 16:33:13 +05:45
Johannes
cc50019e0c Merge branch 'main' of github.com:formbricks/formbricks into docs-update 2023-10-07 16:05:06 +05:45
Johannes
91caac94b6 update docs page 2023-10-07 15:54:43 +05:45
Johannes
c9fea202c4 fix nav link 2023-10-07 15:38:23 +05:45
Johannes
fe12dc7ca9 refactor: Updating Twitter to X Logo in Footer
refactor: Updating Twitter to X Logo in Footer
2023-10-07 15:04:38 +05:45
Johannes
4313745517 fix: typo in mega prompt
fix: typo in mega prompt
2023-10-07 15:02:27 +05:45
Johannes
64c1708ef8 fix: Display Single Use Link Generator instead of Link Preview in Embedding Modal
fix: Display Single Use Link Generator instead of Link Preview in Embedding Modal
2023-10-07 14:58:40 +05:45
Johannes
f8aaa0351f tweak UI 2023-10-07 14:57:00 +05:45
joyal007
c5e7541d72 updated auto submit 2023-10-07 13:45:18 +05:30
Aman
56ce8c10d5 ed Single USe Links in Docs
Signed-off-by: Aman <138197666+aman44444@users.noreply.github.com>
2023-10-07 06:14:16 +00:00
Dhruwang
7e2e0c9739 fixed build errors 2023-10-07 11:34:57 +05:30
Dhruwang
457d34bd70 Merge branch 'issues/SingleUseLinkSurveys' of https://github.com/Dhruwang/formbricks into issues/SingleUseLinkSurveys 2023-10-07 10:30:00 +05:30
Dhruwang
b89e083017 Merge branch 'main' of https://github.com/Dhruwang/formbricks into issues/SingleUseLinkSurveys 2023-10-07 10:29:04 +05:30
Dhruwang
2575b7483b Added single use link modal to shareEmbedSurvey modal 2023-10-07 10:28:23 +05:30
Ayush
86adc0eeff Merge branch 'main' of https://github.com/zaCKoZAck0/formbricks into fix/form_rerender_name_change
merge main
2023-10-07 10:26:04 +05:30
Ayush
5bc4976fb9 fix: form rerender on name change 2023-10-07 09:53:03 +05:30
Yatharth Verma
4875e2c9d4 fix bottom margin as initially when its in fixed, window was getting cut in the top because of navigation bar 2023-10-07 07:57:26 +05:30
Yatharth Verma
74397f27f4 fix merge conflicts 2023-10-07 07:49:50 +05:30
Yatharth Verma
72c4496aac improve animation 2023-10-07 07:47:26 +05:30
sohamtembhurne
802171b6d1 Updating Twitter Logo 2023-10-07 01:14:56 +05:30
joyal007
8f64c5d806 Enter event in option 2023-10-07 00:55:08 +05:30
joyal007
2a73b6460d Added optional enter to submit event 2023-10-07 00:53:38 +05:30
Matti Nannt
6e1bbf19fc fix: build errors (#981) 2023-10-06 19:40:39 +02:00
Yatharth Verma
3d728b782f making animation look natural for maximizing 2023-10-06 23:00:37 +05:30
Anshuman Pandey
fb509d49c9 feat: add base setup to enable file uploads (#861)
* feat: adds api handlers for upload and get file from S3

* feat: upload and fetch files from local storage

* feat: upload and fetch files from local storage

* feat: adds restriction check for allowed file extesnsions

* refactor

* fix: uses t3 env for validation

* fix: fixes validation issues in storage api

* merge with main

* fix: moves UPLOADS_DIR to constants file

* fix: moves private uploads to responseId

* chore: merge with main

* fix: changes api route

* remove comment in storage service, use services in client storage route

* simplify client storage endpoint

* rename fileType to contentType

* relocate storage endpoints, update validation

* update management storage route for readability

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-06 19:06:48 +02:00
Shivani Palya
3e620d7a89 Merge pull request #1 from Shivanipalya26/Shivanipalya26-patch-1
Update megaprompt.md
2023-10-06 22:29:34 +05:30
Shivani Palya
53d8c142c3 Update megaprompt.md 2023-10-06 22:28:53 +05:30
Johannes
6e9b53e68e Update README to highlight contributors
Update README to highlight contributors
2023-10-06 19:48:38 +05:45
Johannes
c7580f0793 feat: Added a not-connected state to the survey state indicator
feat: Added a not-connected state to the survey state indicator
2023-10-06 19:40:42 +05:45
Matti Nannt
5b981e0d91 chore: delete unused uploads directory (#979) 2023-10-06 14:32:54 +02:00
mohitd404
18d7bd0686 Fixed #974 Updated README.md
Updated contributors section in readme.md
2023-10-06 15:56:35 +05:30
Prasoon Mahawar
32633656ae added condition for in-app survey only 2023-10-06 10:05:20 +00:00
Naitik
3bf7d732c2 Fixed where empty pattern was passed when switching from phone 2023-10-06 14:51:01 +05:30
joyal007
20a9b4f3c4 CTA auto skip prevented 2023-10-06 14:43:12 +05:30
Dhruwang
334aacc00c Merge branch 'main' of https://github.com/Dhruwang/formbricks into issues/SingleUseLinkSurveys 2023-10-06 14:43:06 +05:30
joyal007
9a080db936 added hover and focus event 2023-10-06 14:42:40 +05:30
Naitik Kapadia
c9f22290c4 Merge branch 'formbricks:main' into main 2023-10-06 14:32:57 +05:30
joyal007
83a95712e4 long text on enter new line 2023-10-06 14:24:12 +05:30
joyal007
105e32bf6c multi-choice hit enter submit 2023-10-06 14:23:22 +05:30
joyal007
bb206b093e multi question deselect bug fixed 2023-10-06 14:22:06 +05:30
Prasoon Mahawar
24a60bbc10 Merge remote-tracking branch 'refs/remotes/origin/main' 2023-10-06 08:26:54 +00:00
Prasoon Mahawar
f3280292ac Added a not-connected state to the survey state indicator 2023-10-06 08:22:46 +00:00
Johannes
197616ff4d fix: backButton and button target mixup
fix: backButton and button target mixup
2023-10-06 13:14:55 +05:45
Johannes
10e3dd37db fix drop off calculation 2023-10-06 12:46:13 +05:45
ShubhamPalriwala
96e3ba3cc9 fix: backButton and button target mixup & revert input validation 2023-10-06 12:20:23 +05:30
Naitik Kapadia
8eee903bfe Merge branch 'formbricks:main' into main 2023-10-06 11:56:27 +05:30
Johannes
d748c49f13 Merge branch 'main' of github.com:formbricks/formbricks into fix/keyboard-form-usablity 2023-10-06 11:28:57 +05:45
Johannes
8dd5623883 tweak UI 2023-10-06 10:31:58 +05:45
Johannes
818208fdce Merge branch 'main' of github.com:formbricks/formbricks into issues/SingleUseLinkSurveys 2023-10-06 09:40:35 +05:45
Johannes
ab7a072f55 chore: Fix typo
chore: Fix typo
2023-10-06 09:16:22 +05:45
Salim B
caaf903160 Fix sentence 2023-10-06 04:19:23 +02:00
Johannes
efb1033553 lp: update leaderboard
lp: update leaderboard
2023-10-05 23:46:05 +05:45
Johannes
977078d269 update leaderboard 2023-10-05 23:45:09 +05:45
Johannes
eb2a4bc0d2 chore: Add Hook0 to OSS Friends
chore: Add Hook0 to OSS Friends
2023-10-05 23:36:34 +05:45
François-Guillaume Ribreau
53c46418fa feat: add hook0 2023-10-05 17:16:24 +02:00
Matti Nannt
05c4dbaa92 chore: improve error logging in survey service (#958)
* fix: improve error logging in survey service

* expect error class in error logging
2023-10-05 16:46:30 +02:00
Shubham Palriwala
09f885d365 feat: auto generate formbricks encryption key in one click setup (#953)
* fix: docker env parsing & response bug when built w docker

* chore: bring back env example

* fix: docker compose envs are now single place defined

* add: renaming of .env in docs

* remove: existence of prisma_generate_data_proxy

* fix: use newer env vars and a smarter way to handle existing .env file

* fix: remove text to remove existing .enb

* fix: remove comments, local testing, and mention of more updating via echo in prod script

* fix: env ending

* fix: finalllyyy the docker compose works

* wip

* fix: update self host docker compose

* fix: echo log rename
2023-10-05 16:14:23 +02:00
Matti Nannt
7e74cfa0d6 chore: update npm dependencies (#954)
* update packages npm packages

* fix types bug

* update demo npm packages

* update web npm packages

* change formbricks-web to v1.1
2023-10-05 16:11:21 +02:00
Matti Nannt
a612eafee5 fix: docker release deployment pipeline (#957) 2023-10-05 16:09:18 +02:00
Naitik
32b1431939 Revert weird package.json 2023-10-05 16:51:55 +05:30
Naitik
d6f5120e53 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-05 16:42:38 +05:30
Matti Nannt
c6779783dc feat: add ASSET_PREFIX_URL to add support for proxies (#917)
* feat: add ASSET_PREFIX_URL to add support for proxies

* cleanup
2023-10-05 11:27:16 +02:00
Shubham Palriwala
cb8c08dd1f fix: update docker from source setup with new env variables and use env variables directly in docker-compose (#818)
* fix: docker env parsing & response bug when built w docker

* chore: bring back env example

* fix: docker compose envs are now single place defined

* add: renaming of .env in docs

* remove: existence of prisma_generate_data_proxy

* fix: use newer env vars and a smarter way to handle existing .env file

* fix: remove text to remove existing .enb

* fix: remove comments, local testing, and mention of more updating via echo in prod script

* fix: env ending

* fix: finalllyyy the docker compose works

* feat: short survey url support in docker compose

* fix: add envs to prod script

* chore: reorder env vars for uniformity

* update description for SHORT_SURVEY_BASE_URL

* fix: add ASSET_PREFIX_URL to prod script & docker compose

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-05 11:04:34 +02:00
Naitik
5e772f38ec Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-05 13:30:20 +05:30
Shubham Palriwala
940332ced9 fix: survey validation bug and verbose logging (#951) 2023-10-05 09:51:20 +02:00
Naitik
48105c9e8f Ensure Type Safety for inputType 2023-10-05 13:18:09 +05:30
Naitik
5245c29739 Replaced margin with space-x-2 and default placeholder 2023-10-05 13:02:07 +05:30
Shubham Palriwala
0c6acc0d41 feat: add authorization for webhook creation, updation, deletion actions (#912)
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-05 09:28:47 +02:00
Subham Ray
ff39086d21 feat: add Url Shortener (#895)
* WIP

* added prisma actions

* remove console.logs

* some more fixes

* tweaks

* addressed all PR review comments

* remove hits from the prisma schema and all its corresponding service logic

* add nanoid

* corrected placeholders

* change database model, bring shortUrl service up to Formbricks code conventions

* update UI and shortUrl endpoint to work with new service

---------

Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-05 09:22:52 +02:00
Naitik
b0c03d52e1 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-05 12:17:18 +05:30
Dhruwang
652c9d9de0 cleaned up unused code 2023-10-05 10:38:57 +05:30
Johannes
5f19ffabd1 feat: added port info and guide in gitpod doc page
feat: added port info and guide in gitpod doc page
2023-10-05 07:23:40 +05:45
Johannes
193855c3ff Merge branch 'main' of github.com:formbricks/formbricks into gitpod-doc 2023-10-05 07:16:45 +05:45
Piyush Gupta
cddbabc4ad fix: build error (#949) 2023-10-04 22:30:29 +02:00
Naitik
815c642a37 Made title for phone more clear 2023-10-05 00:58:57 +05:30
Naitik
32f793e43c Remove Please as it duplicates 2023-10-05 00:57:03 +05:30
Naitik
54951822c3 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-05 00:47:38 +05:30
Johannes
06f03f65ca feat: Better Embedding of Link Surveys
feat: Better Embedding of Link Surveys
2023-10-04 23:35:30 +05:45
Anjy Gupta
2ec2695cde Merge branch 'gitpod-doc' of https://github.com/anjy7/formbricks into gitpod-doc 2023-10-04 17:42:04 +00:00
Anjy Gupta
d0385eb203 Merge branch 'formbricks:main' into gitpod-doc 2023-10-04 23:10:20 +05:30
Anjy Gupta
999203531f added back ticks 2023-10-04 17:38:52 +00:00
Anjy Gupta
6e4f9cde5c highlighted url 2023-10-04 17:35:47 +00:00
Naitik
4a90d87058 HTML Validation, Proper UI 2023-10-04 23:04:49 +05:30
Joe
59752f3ebe feat: add option to overwrite color and position for single surveys (#645)
* feat: styles ui

* feat: handling brand color and position

* schema update

* survey type update

* feat: local styles preview

* prisma migration

* feat: overriding global settings

* fix: update wording

* fix: do not show positioning in link mode

* update wording

* feat: new component for placement ui

* fix: destructuring localsurvey

* fix: overwritePosition optional

* fix: brandcolor zod validation

* feat: overwrite highlight border setting

* update wording

* merge conflit resolved

* fix: minor review suggestions

* fix: renamed localsurvey to survey

* fix: db schema

* fix comment in .env.example

* fix build errors

* fix: placement

* fix getFirstEnvironmentByUserId function

* fix build errors

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com>
2023-10-04 19:09:48 +02:00
joyal007
438ffcd77f conflict resolve 2023-10-04 22:09:01 +05:30
joyal007
b433275cb5 Merge conflict resolved' 2023-10-04 22:07:21 +05:30
joyal007
4dee291e32 radio button index updated 2023-10-04 22:07:20 +05:30
joyal007
8d9d9e7d76 merge conflic resolved 2023-10-04 22:07:20 +05:30
joyal007
6deab8fdcf removed CTA button tabindex 2023-10-04 22:07:20 +05:30
joyal007
55c2830085 updated focus issue 2023-10-04 22:07:20 +05:30
joyal007
a126cc14a0 conflict resolved 2023-10-04 22:07:20 +05:30
joyal007
f8f5826151 added tabindex 2023-10-04 22:07:20 +05:30
joyal007
372ae167e0 updated tabindex 2023-10-04 22:07:20 +05:30
joyal007
5ffd8f748d updated tabindex 2023-10-04 22:07:20 +05:30
joyal007
5f2f9717fd updated tabindex 2023-10-04 22:07:20 +05:30
joyal007
f830f59e67 added tabindex 2023-10-04 22:07:20 +05:30
joyal007
882b3c4195 keyboard usablity 2023-10-04 22:07:20 +05:30
Rotimi Best
de40dc36e6 chore: move all services into the new folder structure (#948)
* chore: move environment services

* chore: move all services
2023-10-04 18:04:38 +02:00
Anjy Gupta
1c4394bf75 Merge branch 'formbricks:main' into gitpod-doc 2023-10-04 21:26:56 +05:30
Anjy Gupta
b121e69fb5 added gitpod setup overview 2023-10-04 15:56:31 +00:00
Piyush Gupta
9e19d11eed purged LinkSurveyModal, fixed build error 2023-10-04 21:04:54 +05:30
Piyush Gupta
7580840bb5 resolved merge conflicts 2023-10-04 20:55:45 +05:30
Rotimi Best
6758d2d318 chore: move actions service to new folder structure (#943)
* feat: move actions service

* fix: rename folder to be singular not plural

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-04 17:00:03 +02:00
Rotimi Best
61a850c4ea fix: delete duplicate displays (#947) 2023-10-04 16:41:41 +02:00
Rotimi Best
99ec1ed4e9 fix: standardize error messaging in all service (#920)
* fix: standardize error messaging in all service

* fix: use unknownerror
2023-10-04 16:29:49 +02:00
Sagnik Sahoo
d9f3df8b0f fix: Single Use Link Preview is not correctly functioning (#938)
* fixing the preview link

* Update LinkSingleUseSurveyModal.tsx
2023-10-04 16:27:24 +02:00
Rotimi Best
eb70a8b99a chore: move display service to new folder structure (#946) 2023-10-04 16:25:26 +02:00
dependabot[bot]
16603f1a42 chore(deps-dev): bump postcss from 8.4.30 to 8.4.31 (#939)
Bumps [postcss](https://github.com/postcss/postcss) from 8.4.30 to 8.4.31.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/postcss/postcss/compare/8.4.30...8.4.31)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-04 16:24:14 +02:00
dependabot[bot]
9dfdd4e6ce chore(deps): bump zod from 3.22.2 to 3.22.3 (#940)
Bumps [zod](https://github.com/colinhacks/zod) from 3.22.2 to 3.22.3.
- [Release notes](https://github.com/colinhacks/zod/releases)
- [Changelog](https://github.com/colinhacks/zod/blob/master/CHANGELOG.md)
- [Commits](https://github.com/colinhacks/zod/compare/v3.22.2...v3.22.3)

---
updated-dependencies:
- dependency-name: zod
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-04 16:23:43 +02:00
Piyush Gupta
c69e3f5cca fix: resolved PR review changes 2023-10-04 19:11:25 +05:30
Rotimi Best
424cddfa9e chore: move attributeClass service to new folder structure (#944)
* chore: move attributeClass service

* update person service with new attributeClass location
2023-10-04 15:25:08 +02:00
Johannes
8897d3ed66 Validate Survey Editor Form
Validate Survey Editor Form
2023-10-04 18:36:59 +05:45
Rotimi Best
07d0f3e751 fix: move close comment to end in .env.example (#945) 2023-10-04 14:34:31 +02:00
ShubhamPalriwala
16a94ef61f fix: add missing state set on fail 2023-10-04 18:04:06 +05:30
ShubhamPalriwala
f97c8e5bce Merge branch 'shubham/for-1150-validate-survey-editor-forms' of https://github.com/formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-10-04 17:47:53 +05:30
Piyush Gupta
c57c06dd3b merged main into feat/embed-xp 2023-10-04 17:35:53 +05:30
Matthias Nannt
188f61bda6 merge latest changes, solve merge conflicts 2023-10-04 13:07:10 +02:00
Shubham Palriwala
a78c19385e fix: generate single survey Ids in summary only if enabled (#942) 2023-10-04 13:04:47 +02:00
Dhruwang
7ae1599c03 fix: display count not getting decremented 2023-10-04 16:26:20 +05:30
Dhruwang
f01f55521a fix: display count not getting decremented 2023-10-04 16:24:34 +05:30
Dhruwang
c440d6b486 fix: display count not getting decremented 2023-10-04 16:23:14 +05:30
Dhruwang
3222649ae0 Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-04 14:51:47 +05:30
Shubham Palriwala
cce3a98f20 feat: add docs for management API (#930)
* feat: docs for management API

* fix: split api into client and management

* update navigation and pages

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-04 11:03:13 +02:00
Johannes
b13dbc7fea reword toast 2023-10-04 14:23:09 +05:45
Johannes
3b24569e8e Merge branch 'main' of github.com:formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-10-04 14:06:44 +05:45
Johannes
66d38b1449 feat: faq section on landing page as well as docs
feat: faq section on landing page as well as docs
2023-10-04 13:31:56 +05:45
Johannes
082691d0b3 fix typo 2023-10-04 13:31:29 +05:45
Johannes
d3779bd649 fix typos 2023-10-04 13:24:07 +05:45
Naitik
57234cf012 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-04 12:09:53 +05:30
Dhruwang
d831dc1395 moved Id generation to link Modal button 2023-10-04 11:43:58 +05:30
Johannes
67217f4c75 Merge branch 'main' of github.com:formbricks/formbricks into shubham/for-1089-formulate-faqs-and-create-page 2023-10-04 11:33:09 +05:45
joyal007
95b937e63d updated 2023-10-04 09:34:15 +05:30
Joyal Raphel
58bccac12a Merge branch 'formbricks:main' into fix/keyboard-form-usablity 2023-10-04 09:30:33 +05:30
joyal007
8d05cf25a8 added tabindex 2023-10-04 09:27:02 +05:30
joyal007
c267dc9b66 updated tabindex 2023-10-04 09:27:02 +05:30
joyal007
4221a9390f updated tabindex 2023-10-04 09:27:02 +05:30
joyal007
b6ed2e6530 updated tabindex 2023-10-04 09:27:02 +05:30
joyal007
080ddb6f48 added tabindex 2023-10-04 09:27:02 +05:30
joyal007
a2128d2a66 keyboard usablity 2023-10-04 09:27:02 +05:30
Matti Nannt
94e272f47b fix: validation error in profile update input (#937) 2023-10-03 22:03:20 +02:00
Shubham Palriwala
c6678a2607 fix: add authorization for Survey actions (#870)
* poc: use server session and api key validation on deletion

* feat: use server session and api key validation on deletion and creation

* feat: packages/lib/apiKey for apiKey services and auth

* shubham/auth-for-api-key

* fix: caching

* feat: handle authorization for action creation, update, delete

* feat: handle authorization for survey creation, updation & deletion

* feat: use cached method across and wrapper for authzn check

* fix: use cached wrapper & introduce more authzn check for survey services in actions

* fix: club caching methods and use authzn errors

* feat: add caching in canUserAccessApiKey

* feat: add caching in canUserAccessAction and use Authzn error

* fix: rename action to actionClass wherever needed

* feat: use caching in core method and update hasEnvAccess call

* fix: use authzn specific error

* fix: use cache getActionClass

* fix: make changes

* fix: import

* fix: import and suggested changes

* fix: rename action and use cache tag

* feat: use services to create team

* fix: atomic services for product & team creation

* improve teamUpdateInput

* use services in signup process

* redirect to prod environment when new product is created

* fix signup bug

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-03 21:43:34 +02:00
Naitik Kapadia
1ddfe493e5 Merge branch 'formbricks:main' into main 2023-10-03 23:48:44 +05:30
Naitik
8585df90b3 Fixed Phone Number Regex 2023-10-03 23:47:45 +05:30
Johannes
2f95db729c update leaderboard
update leaderboard
2023-10-03 23:24:21 +05:45
Johannes
76ecbb9e2f update leaderboard 2023-10-03 23:22:09 +05:45
Piyush Gupta
83ab524200 merged with remote changes 2023-10-03 23:00:30 +05:30
Yatharth Verma
32f8ce593a Merge: latest branch 2023-10-03 22:57:24 +05:30
Yatharth Verma
e7fd94e412 Improvements: Done all the changes suggested by Johannes 2023-10-03 22:51:32 +05:30
Piyush Gupta
92681b0f81 fix: preview mode in email tab 2023-10-03 22:51:12 +05:30
Piyush Gupta
28ab3c3e4d synced with main 2023-10-03 22:50:11 +05:30
tyjkerr
a35d573884 feat: add single use survey links (#742)
* add uniqueResponseId to link survey

* add uniqueResponseId to survey response

* add singUseId to database and link survey

* add singleUseId to api

* add single use option in survey response options

* add single use to getSurvey

* add getResponseBySingleUseId

* add ZSurveySingleUse schema to survey schema

* add logic to check if link with suid has response

* pass singleUseId as props, revert SWR changes

* generation of single-use url in LinkSurveyModal

* add singleUseId to SingleResponseCard

* update SurveyInactive for invalid link

* add suId to ZResponse schema

* fix typo in SurveyInactive

* update ResponseOptionCard

* add suId to response select

* add default message for SurveyLinkUsed

* update logic to render SurveyLinkUsed

* add comment for suId in prisma schema

* fix types

* refresh server component on save survey

* update logic

* fix build errors

* fix prisma schema

* add db migration

* update wording

* add singleUseId to localstorage

* fix survey link used over thank you

* add suid to people responses

* fix preview and copy link on surveys page.

* update text and icon for link survey modal

* check survey not finished before setting question

* update show surveylink used logic

* add zodtype to prisma

* fix logic to render last question answered/stored

* add better comments

* update default message for single use surveys

* add LinkSingleUseSurveyModal

* add guard before getting response with suid

* fix build error

* add default message for link used page

* add key and group imports

* add suId encryption and validation

* make survey url encryption optional

* fix build errors

* move singleUseId to server side in surveyList

* added validation to getResponseBySingleUseId service

* restored env var names

* import FORMBRICKS_ENCRYPTION_KEY from constants

* check if encryption environment variable is set, add length validation for env variable

---------

Co-authored-by: Ty Kerr <tykerr@Tys-MacBook-Pro.local>
Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
2023-10-03 18:26:13 +02:00
Anjy Gupta
b710c8961b Merge branch 'formbricks:main' into gitpod-doc 2023-10-03 21:23:52 +05:30
Anjy Gupta
4c60791929 made req changes 2023-10-03 15:52:18 +00:00
Johannes
251beb4d51 ui tweaks 2023-10-03 21:36:16 +05:45
Dhruwang
79d05a4c57 Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-03 21:07:16 +05:30
Piyush Gupta
5384e7f95e resolved merge conflicts 2023-10-03 21:06:38 +05:30
joyal007
b4f10137a8 keyboard usablity 2023-10-03 20:35:02 +05:30
Shubham Palriwala
8f35537bbf fix: smiley rating question now fits inside container (#839)
* fix: smily rating question fit inside container

* wip

* fix: make row center aligned
2023-10-03 14:59:32 +02:00
Dhruwang
09523c318d Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-03 18:25:08 +05:30
Shubham Palriwala
49eb4e0c53 feat: connection states on integrations (#833)
* feat: connection states on integrations

* fix: missing action buttons

* make text more readable

---------

Co-authored-by: Johannes <johannes@formbricks.com>
2023-10-03 14:28:55 +02:00
Rotimi Best
66ea2069ac chore: move revalidation interval to a constant (#921) 2023-10-03 14:01:26 +02:00
Rotimi Best
4b1352a995 fix: remove direct usage of prisma type in services (#919) 2023-10-03 13:56:48 +02:00
Rotimi Best
9fbefa42dd fix: remove error prone unused function in services (#918) 2023-10-03 13:55:23 +02:00
Rotimi Best
2cf316b620 fix: rename function name typo in services (#922) 2023-10-03 13:54:26 +02:00
Rotimi Best
8a07b2f82d feat: use of server-only consistently in services (#923) 2023-10-03 13:53:34 +02:00
Naitik Kapadia
e2572ff87b Merge branch 'formbricks:main' into main 2023-10-03 15:49:47 +05:30
Naitik
6c0d356c2a Component for QuestionTypeSelector 2023-10-03 15:44:28 +05:30
Johannes
41fa1d729d docs: improve pull request template with latest info
docs: improve pull request template with latest info
2023-10-03 15:41:03 +05:45
Johannes
7ce4e58755 tweak wording 2023-10-03 15:40:14 +05:45
Dhruwang
75e17e8aa6 added service deleteResponseById 2023-10-03 15:14:56 +05:30
Anjy Gupta
d3d74b2a6c Merge branch 'formbricks:main' into gitpod-doc 2023-10-03 15:13:29 +05:30
Anjy Gupta
b09cc8a25f added step by step guide 2023-10-03 09:43:00 +00:00
Matti Nannt
a8e0e7d3f2 fix: display count not correct in link surveys (#929) 2023-10-03 11:28:55 +02:00
Rotimi Best
ca5f505fbd rename from Not required to optional 2023-10-03 09:55:59 +01:00
Rotimi Best
4584c1e287 fix mix match 2023-10-03 09:55:04 +01:00
Rotimi Best
9c83abb680 docs: improve pull request template with latest info 2023-10-03 09:43:05 +01:00
Johannes
20ec6781e1 add gitpod prize to FormTribe hackathon page
add gitpod prize to FormTribe hackathon page
2023-10-03 14:07:48 +05:45
Johannes
2d9f35f503 add gitpod prize 2023-10-03 14:06:59 +05:45
Johannes
fe475a5b48 update how to section FormTribe
update how to section FormTribe
2023-10-03 12:58:42 +05:45
Johannes
0620829830 update how to section 2023-10-03 12:56:25 +05:45
Dhruwang
49a288e83e Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-10-03 10:58:53 +05:30
Naitik
b2237bb5e5 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-03 10:12:43 +05:30
Johannes
027f7f13ba Merge branch 'main' of github.com:formbricks/formbricks into feat/full-screen-link-survey-preview 2023-10-03 09:01:00 +05:45
Johannes
727f09aa6e Fix/multi select optional
Fix/multi select optional
2023-10-03 08:45:10 +05:45
Anjy Gupta
fb1f622d9d feat: added port info and guide in gitpod doc page 2023-10-02 19:00:57 +00:00
Naitik
6ef5a4bcc0 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-02 23:38:27 +05:30
PratikAwaik
b0d070b1a9 Merge branch 'main' of https://github.com/formbricks/formbricks into fix/multi-select-optional 2023-10-02 22:33:16 +05:30
PratikAwaik
bd559219b8 fix next button click 2023-10-02 22:33:02 +05:30
Jonas Höbenreich
89a60fd568 feat: add Excel download option (#846)
* add Excel download option

* add back attribute export

* add types and check for download filetype

* add xlsx package

* move csv and excel conversion to internal endpoints

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-02 17:04:11 +02:00
Naitik
5e4d92205c Changed templates.ts 2023-10-02 19:55:50 +05:30
Naitik
444c0b8f36 Small Fix 2023-10-02 19:36:41 +05:30
Naitik
178b5c6ee3 Merge branch 'main' of https://github.com/KapadiaNaitik/formbricks 2023-10-02 19:32:55 +05:30
Naitik
adc5e30dca Remove redunant import 2023-10-02 19:32:24 +05:30
Naitik
b5737ea611 Merge branch 'main' of https://github.com/formbricks/formbricks 2023-10-02 19:32:04 +05:30
Shubham Palriwala
8c0aba82e5 fix: add authorisation for tags actions (#897)
* poc: use server session and api key validation on deletion

* feat: use server session and api key validation on deletion and creation

* feat: packages/lib/apiKey for apiKey services and auth

* shubham/auth-for-api-key

* fix: caching

* feat: handle authorization for tag creation, updation & deletion

* fix: use cached wrapper

* fix: club caching methods and use authzn errors

* feat: add caching in canUserAccessApiKey

* fix: suggrsted changes and authzn for response as well

* fix: work on suggested changes

* fix broken lock file

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-02 16:00:25 +02:00
Naitik Kapadia
7bb6a0ba7d Merge branch 'formbricks:main' into main 2023-10-02 19:28:03 +05:30
Naitik
cf75b4850d Validation Fields 2023-10-02 19:27:37 +05:30
Shubham Palriwala
a9c8e99cd4 fix: add authorization to actions for Profile (#908)
* feat: authzn and limit sensitive info from profile actions

* fix: work on suggested changes
2023-10-02 15:40:15 +02:00
Yatharth Verma
8219905d27 feat: Improve animation 2023-10-02 18:19:51 +05:30
Johannes
bcaf2337c4 update leaderboard
update leaderboard
2023-10-02 17:11:47 +05:45
Johannes
baef77aa98 fix: multi select evaluator and required
fix: multi select evaluator and required
2023-10-02 17:09:07 +05:45
Johannes
1275ae81b3 Merge branch 'main' into fix/multi-select-optional 2023-10-02 17:08:53 +05:45
Johannes
829d2f0297 update leaderboard 2023-10-02 17:04:12 +05:45
Shubham Palriwala
c4b4d2a312 chore: add authorization to server actions for Actions (#868)
* poc: use server session and api key validation on deletion

* feat: use server session and api key validation on deletion and creation

* feat: packages/lib/apiKey for apiKey services and auth

* shubham/auth-for-api-key

* fix: caching

* feat: handle authorization for action creation, update, delete

* feat: use cached method across and wrapper for authzn check

* fix: club caching methods and use authzn errors

* feat: add caching in canUserAccessApiKey

* feat: add caching in canUserAccessAction and use Authzn error

* fix: rename action to actionClass wherever needed

* fix: use cache getActionClass

* fix: make changes

* fix: import

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-02 13:03:49 +02:00
Johannes
e01d5a44f4 fix lock file (#904) 2023-10-02 12:42:28 +02:00
Johannes
289d36d509 style: Add corresponding icons to type indicator #892
style: Add corresponding icons to type indicator #892
2023-10-02 16:01:52 +05:45
PratikAwaik
015c26a1ef fix multi select evaluator and requirewd 2023-10-02 15:46:44 +05:30
Aditya Deshlahre
cfe6e3628d Merge branch 'main' into adityadeshlahre/formtribe 2023-10-02 14:12:30 +05:30
Shubham Palriwala
c470c024c5 fix: Add authorisation for API Key server actions (#741)
* poc: use server session and api key validation on deletion

* feat: use server session and api key validation on deletion and creation

* feat: packages/lib/apiKey for apiKey services and auth

* shubham/auth-for-api-key

* fix: caching

* fix: club caching methods and use authzn errors

* feat: add caching in canUserAccessApiKey
2023-10-02 10:13:19 +02:00
Johannes
532d66bb34 feat: Mandatory question indicator added
feat: Mandatory question indicator added
2023-10-02 13:47:12 +05:45
Johannes
f4811ecee2 update cta 2023-10-02 13:46:39 +05:45
Shubham Palriwala
9e91e572ba fix: unable to add a new action while editing a survey (#899) 2023-10-02 09:37:33 +02:00
Johannes
7269303b71 tweak styling 2023-10-02 13:21:36 +05:45
Yatharth Verma
cb7eb8b19f feat: Add full screen preview feature 2023-10-02 11:40:39 +05:30
Aditya @ArchLinux
dab6b86717 Fixed Source of Question type & icon 2023-10-02 10:40:58 +05:30
Piyush Gupta
55c29c6a73 resolved review changes 2023-10-02 10:06:11 +05:30
Johannes
d3b2e0ba7b Lp/leaderboard update
Lp/leaderboard update
2023-10-02 10:17:35 +05:45
Johannes
7ef95bc284 update banner 2023-10-02 10:15:46 +05:45
Johannes
7d9617e27f update leaderboard 2023-10-02 10:05:40 +05:45
Aditya @ArchLinux
0892bbd898 Selection Fix 2023-10-02 02:23:07 +05:30
Aditya Deshlahre
8549ac61c2 Merge branch 'formbricks:main' into adityadeshlahre/formtribe 2023-10-02 01:28:32 +05:30
Aditya @ArchLinux
2ab90c14b9 Add corresponding icons to type indicator #892 2023-10-02 01:10:04 +05:30
Johannes
6e2b4e2aef Lp/leaderboard
Lp/leaderboard
2023-10-02 00:12:39 +05:45
Johannes
af1dc2c08b side quest tweaks 2023-10-01 23:43:49 +05:45
Johannes
a032d8aad6 add button to issue 2023-10-01 23:42:28 +05:45
Johannes
5557f22a4b add leaderboard 2023-10-01 23:33:25 +05:45
Piyush Gupta
5fad91dcb7 feat:mandatory question indicator added 2023-10-01 19:18:04 +05:30
Johannes
f01adaf994 Docs: Add cla form to getting started doc
Docs: Add cla form to getting started doc
2023-10-01 17:21:47 +05:30
Rotimi Best
48f1ed4d78 docs: update wording 2023-10-01 11:47:19 +00:00
Rotimi Best
81a6e92aed docs: add cla form to getting started doc 2023-10-01 11:29:45 +00:00
Johannes
030e8556fb fix: Progress bar reset
fix: Progress bar reset
2023-10-01 16:21:09 +05:30
Johannes
4b978b4ac4 Release Side Quests
Release Side Quests
2023-10-01 16:14:15 +05:30
Johannes
15d75a2856 release side quests 2023-10-01 16:11:14 +05:30
Dhruwang
0027835af2 fix: Progress bar reset 2023-10-01 16:00:28 +05:30
Shubham Palriwala
769ceb1fc2 refactor: @formbricks/api package (#782)
* init: rewritten formbricks api package

* restrucure: client prepended formbricks api package

* feat: cleanup error templating and node-fetch for non browser access

* feat: replace package (build error for js packge due to api)

* fix: rename methods & move error type

* fix: imports of api via js

* remove node-fetch

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-10-01 11:50:29 +02:00
Johannes
e3069f7bab Blog: Join the FormTribe blog post
Blog: Join the FormTribe blog post
2023-10-01 15:14:39 +05:30
Johannes
3af8a4e17d add gitpod docs page, tweak pricing table 2023-10-01 15:10:26 +05:30
Johannes
1faa74864c Merge branch 'main' of github.com:formbricks/formbricks into join-formtribe 2023-10-01 14:46:07 +05:30
Johannes
eac75c29b6 Docs: How we code documentation
Docs: How we code documentation
2023-10-01 14:44:17 +05:30
Johannes
9bed96a22f Merge branch 'main' of github.com:formbricks/formbricks into how-we-code 2023-10-01 14:42:14 +05:30
Johannes
14e8c43214 Merge branch 'main' of github.com:formbricks/formbricks into how-we-code 2023-10-01 14:37:31 +05:30
Johannes
6d36bb8cb7 Merge branch 'main' of github.com:formbricks/formbricks into join-formtribe 2023-10-01 14:35:37 +05:30
Johannes
d5b67f4a14 Merge branch 'main' of github.com:formbricks/formbricks into join-formtribe 2023-10-01 14:20:07 +05:30
Johannes
e2c3686f2f add gitpod docs 2023-10-01 14:16:16 +05:30
Piyush Gupta
6533d9834b resolved merge conflicts 2023-10-01 10:22:24 +05:30
Piyush Gupta
1033ac745a fix: preview email survey url 2023-10-01 10:15:04 +05:30
Matti Nannt
6af13c7aaa feat: add vercel.json file to configure Vercel deployments (#876)
* feat: add vercel.json file to configure Vercel deployments

* reduce maxDuration of sync endpoint

* update api function routes

* increase sync limit
2023-09-30 22:42:27 +02:00
Matti Nannt
5aad6ea095 fix: invalid validation of VERCEL_URL leads to build errors on Vercel (#875)
* fix: invalid validation of VERCEL_URL leads to build errors on Vercel

* fix build errors
2023-09-30 22:07:17 +02:00
Shubham Palriwala
13afba7615 feat: move env vars from build-time to run-time to better support self-hosting environments (#789)
* feat: privacy, imprint, and terms URL env vars now do not need rebuilding

* feat: disable_singup env var now do not need rebuilding

* feat: password_reset_disabled env var now do not need rebuilding

* feat: email_verification_disabled env var now do not need rebuilding

* feat: github_oauth & google_oauth env var now do not need rebuilding

* feat: move logic of env vars to serverside and send boolean client-side

* feat: invite_disabled env var now do not need rebuilding

* feat: rename vars logically

* feat: migration guide

* feat: update docker-compose as per v1.1

* deprecate: unused NEXT_PUBLIC_VERCEL_URL & VERCEL_URL

* deprecate: unused RAILWAY_STATIC_URL

* deprecate: unused RENDER_EXTERNAL_URL

* deprecate: unused HEROKU_APP_NAME

* fix: define WEBAPP_URL & replace NEXT_WEBAPP_URL with it

* migrate: NEXT_PUBLIC_IS_FORMBRICKS_CLOUD to IS_FORMBRICKS_CLOUD

* chore: move all env parsing to a constants.ts from page files

* feat: migrate client side envs to server side

* redo: isFormbricksCloud to navbar serverside page

* fix: constants is now a server only file

* fix: removal of use swr underway

* fix: move 1 tag away from swr to service

* feat: move away from tags swr

* feat: move away from surveys  swr

* feat: move away from eventClass swr

* feat: move away from event swr

* fix: make constants server-only

* remove comments from .env.example, use constants in MetaInformation

* clean up services

* rename tag function

* fix build error

* fix smaller bugs, fix Response % not working in summary

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-30 21:40:59 +02:00
Ikko Eltociear Ashimine
3c2087452c fix: typo in comment in find-first.ts (#874)
enviroment -> environment
2023-09-30 18:01:14 +02:00
Anshuman Pandey
0225362a92 feat: Add caching to more services (survey, environment, team, profile) (#835)
* feat: caching in surveys

* fix: fixes unstable_cache date parsing error

* fix: fixes survey revalidation in displays and responses

* fix: fixes survey cache

* fix: adds comments

* fix: response cache tag

* fix cache validation and tag naming

* move TSurveysWithAnalytics to TSurveys

* add caching to more services

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-30 14:22:42 +02:00
Rotimi Best
7a9a4b9ffc docs: fix env poin without link 2023-09-30 10:13:59 +00:00
Matthias Nannt
f3ef080ec6 downgrade next version to "fix" dev bug 2023-09-30 11:58:05 +02:00
Matthias Nannt
a17e86bc91 fix docs page error, slight change to pricing 2023-09-30 11:12:30 +02:00
Matthias Nannt
d5bb4d4365 Merge branch 'main' of github.com:formbricks/formbricks into how-we-code 2023-09-30 11:02:56 +02:00
Shubham Palriwala
48d8fc6aca feat: add new pricing table to formbricks-com (#869)
* init: pricing page

* fix: ux changes
2023-09-30 11:01:46 +02:00
Rotimi Best
810bd645f8 docs: more self cr 2023-09-30 06:25:59 +00:00
Rotimi Best
0f3aa9434a docs: self code review 2023-09-30 06:24:32 +00:00
Piyush Gupta
9e9c02bc3e fix: build errors 2023-09-30 11:52:02 +05:30
Rotimi Best
2003bb64f6 docs: how we code documentation 2023-09-30 06:09:47 +00:00
Piyush Gupta
1815d86f16 feat: added email sender server action 2023-09-30 11:32:15 +05:30
Rotimi Best
ef604e7660 doc: join the formtribe blog post 2023-09-30 05:25:34 +00:00
Piyush Gupta
0441f0bbbd Merge branch 'main' of https://github.com/formbricks/formbricks into feat/embed-xp 2023-09-29 20:04:36 +05:30
Piyush Gupta
8bf0df7c74 fix: refactoring and responsiveness 2023-09-29 20:04:04 +05:30
Johannes
18ab73e30a Merge branch 'main' of github.com:formbricks/formbricks into shubham/for-1089-formulate-faqs-and-create-page 2023-09-29 13:20:41 +05:30
Piyush Gupta
9ce4c26bc9 refactor embed xp 2023-09-29 12:59:55 +05:30
Piyush Gupta
128ad4cb3a added shareSurveySheet 2023-09-29 11:44:31 +05:30
Shubham Palriwala
95b7a6fb8c fix: action class creation in frontend fails (#867) 2023-09-28 17:10:23 +02:00
Johannes
5b3c07ffc8 shorten delay for tooltip 2023-09-28 18:39:24 +05:30
Matti Nannt
ca19ee6e0f fix: formbricks-js not displaying properly on smaller screens (#866) 2023-09-28 13:02:41 +02:00
ShubhamPalriwala
9871b0bbe0 fix: metadata on faq & remove best practices due to compile issues 2023-09-28 16:14:54 +05:30
ShubhamPalriwala
35ee2925ec Merge branch 'main' of https://github.com/formbricks/formbricks into shubham/for-1089-formulate-faqs-and-create-page 2023-09-28 15:17:15 +05:30
Johannes
70cd70e414 Tweaking Google Sheets Docs
Tweaking Google Sheets Docs
2023-09-28 14:55:19 +05:30
Johannes
2ff7022368 tweaking docs page 2023-09-28 14:54:39 +05:30
Johannes
9b77d89e53 feat: (documentation) google sheets integration
feat: (documentation) google sheets integration
2023-09-28 14:53:06 +05:30
Johannes
c4b6d6d5f4 Merge branch 'main' of github.com:formbricks/formbricks into shubham/for-1346-docs-page-for-google-sheets-integration 2023-09-28 14:40:25 +05:30
Johannes
2083b68388 fix: add structured metadata to landing pages
fix: add structured metadata to landing pages
2023-09-28 14:35:09 +05:30
Johannes
3e2dcd8e74 fix build error 2023-09-28 14:34:09 +05:30
Dhruwang Jariwala
7e626e75a3 feat: Add Management API (#788)
* added some management APIs for response and surveys

* added management API endpoints

* refactored [responseId] route

* added authorisation and made refactors

* removed console logs

* fixed build issues

* remobed session check

* removed getEnvironmentBySession function

* made code refactors

* update variables in route

* add updated routes

* change underscore to hyphen notation

* peoples -> people

* fix build errors

* resolved build errors

* restored types in summary list

* add redirects for old responses and survey endpoints, update docs

* fixed not authenticated response

* update survey create endpoint to only accept necessary fields, clean up

---------

Co-authored-by: Dhruwang Jariwala <dhruwang@Dhruwangs-MacBook-Pro.local>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-28 10:57:45 +02:00
Piyush Gupta
3edf5539d5 pull from upstream main 2023-09-28 06:38:26 +05:30
Piyush Gupta
fba1b1b0a9 feat: added survey preview 2023-09-28 06:28:40 +05:30
Matti Nannt
c98b909c9c fix: validation error in surveyClosedMessage (#864) 2023-09-27 16:29:36 +02:00
Rotimi Best
edbab36d27 docs: update development and self-hosting information in README (#860)
* docs: add prerequisities to readme.md

* docs: reorganize getting started section in README

* docs: break docker into its own section

* update self-hosting structure

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-27 16:03:26 +02:00
Matti Nannt
e27a994ef9 fix: validation error when surveyClosedMessage is undefined (#863) 2023-09-27 15:57:17 +02:00
Ishan Avasthi
8a7f1ff680 fix: typo on FormTribe Landing Page (#859) 2023-09-27 15:48:48 +02:00
Dhruwang Jariwala
07258aabdd chore: Disable administration view on mobile devices (#862)
* Blocks mobile usage

* remove button

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-27 15:47:51 +02:00
Shubham Palriwala
83bc8a8c11 feat: Add pagination to people overview (#830)
* feat: paginante people page

* undo: delete env example

* fix: rename vars and return empty arr over err

* fix: invalid page logic

* fix: handle bigger cases

* increase PEOPLE_PER_PAGE to 50

* fix: show no people when added invalid page no

* feat: add caching in people fetch services

* Revert "feat: add caching in people fetch services"

This reverts commit ab1e98c05e.

* fix build errors

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-27 11:59:44 +02:00
Matti Nannt
48921663be chore: update npm dependencies (#857)
* chore: update npm packages

* update formbricks-web packages

* update packages in demo

* update packages in formbricks-com

* fix survey status dropdown has no value
2023-09-27 11:42:49 +02:00
Dhruwang
fce7ac30f3 removed console log 2023-09-27 14:09:44 +05:30
ShubhamPalriwala
4c45f13b5c fix: missed gdpr pages 2023-09-27 13:39:35 +05:30
Dhruwang
3125369708 solved build errors and added functionality to store displayId in in-app surveys 2023-09-27 13:33:09 +05:30
Dhruwang
944de69acc Merge branch 'main' of https://github.com/Dhruwang/formbricks into redesign-metadata 2023-09-27 10:29:51 +05:30
Dhruwang
36355ef54b redesigned metadata 2023-09-26 16:48:24 +05:30
Rotimi Best
06448fd4e0 feat: In Gitpod open mailhog in browser on setup complete (#849)
* docs: add local and gitpod set

This links to our docs on formbricks.com for local setup and adds a gitpod setup banner

* feat: open mailhog after gitpod setup complete

* remove development doc
2023-09-26 18:42:19 +09:00
Matti Nannt
48ba245336 fix: formtribe page should only be shown in light mode (#854) 2023-09-26 17:39:39 +09:00
Anshuman Pandey
95c466dbba chore: moves prisma logic from set-attribute to person service (#840) 2023-09-26 16:57:25 +09:00
Rotimi Best
8181f74ad4 docs: Add Gitpod Button to Readme (#848)
This links to our docs on formbricks.com for local setup and adds a gitpod setup banner
2023-09-26 16:55:39 +09:00
Dhruwang Jariwala
562aefef6e feat: Add Deploy with Railway Button to Readme (#851) 2023-09-26 16:54:00 +09:00
Dhruwang Jariwala
a3549cc92c fix: Preview not showing correctly after changing the survey type (#852) 2023-09-26 16:52:39 +09:00
Johannes
6c8d14409c feat: Introduce new Landing Page for FormTribe event (#853)
* formtribe lp v1

* fix apos

* responsiveness + tweaks

* add video
2023-09-26 16:50:21 +09:00
Dhruwang
c272b8a75c Updated survey metadata mockup 2023-09-26 00:02:58 +05:30
Piyush Gupta
0a6367e31e feat: added templates for each question type 2023-09-25 23:22:15 +05:30
ShubhamPalriwala
9b6ea3f451 wip 2023-09-25 10:53:23 +05:30
Johannes
cf881127e7 chore: Adds Papermark
chore: Adds Papermark
2023-09-25 10:15:31 +05:30
Anshuman Pandey
23d6135f30 fix: fixes empty in app surveys screen when formbricks-js is not connected (#836)
* fix: fixes empty in app surveys screen

* move analysis components to components folder

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-24 15:54:21 +09:00
tanayvaswani
f24bd9bfc0 Adds Papermark 2023-09-22 18:37:00 +05:30
Johannes
5f11c9ef81 enhancement: Adds manage sheets label to GS integration card
enhancement: Adds manage sheets label to GS integration card
2023-09-22 11:28:08 +02:00
Johannes
2f8cfe0cd5 fix: NPS response issue
fix: NPS response issue
2023-09-22 11:26:55 +02:00
Dhruwang
0acc840ecd fix: NPS question issue 2023-09-22 14:25:54 +05:30
ShubhamPalriwala
7244af921f Merge branch 'main' of https://github.com/formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-09-22 13:47:15 +05:30
Dhruwang
9a9b367478 Adds manage sheets label to GS integration card 2023-09-21 23:45:26 +05:30
Dhruwang Jariwala
01dcd55487 fix: typos in Google Auth environment variables (#841) 2023-09-22 03:10:43 +09:00
Dhruwang Jariwala
9b883c103e fix: use correct whitespaces in responses within notification emails (#842) 2023-09-22 03:06:20 +09:00
Dhruwang Jariwala
04678d6e50 fix : email indentation (#837) 2023-09-21 17:10:39 +09:00
ShubhamPalriwala
958f1960ae feat: everything google sheets integration docs' 2023-09-21 13:19:35 +05:30
ShubhamPalriwala
f2bdeabec1 init: google sheet cloud instance integration 2023-09-21 12:14:40 +05:30
Matti Nannt
66ac652c3c feat: minify formbricks-surveys & formbricks-js using terser (#834) 2023-09-20 13:13:52 +09:00
Piyush Gupta
f153b7f0f2 sync with main 2023-09-19 21:18:56 +05:30
Piyush Gupta
91cb8d8503 added email templates 2023-09-19 21:15:27 +05:30
Matti Nannt
85816af22a fix: remove credentials file (#832) 2023-09-19 23:13:51 +09:00
ShubhamPalriwala
5c7f4510e3 Merge branch 'main' of https://github.com/formbricks/formbricks into shubham/for-1089-formulate-faqs-and-create-page 2023-09-19 19:34:00 +05:30
ShubhamPalriwala
23971f33e7 feat: faq section on landing page as well as docs 2023-09-19 19:24:51 +05:30
Dhruwang Jariwala
21f393f402 feat: Add Google Sheets Integration (#735)
* added intro and surveySelect page

* added home page and  wrapper component

* added spreadsheet select

* added data write functionality and added integration schema model

* improved UX

* reworked UI

* added google sheet integration

* removed some unused code

* added user email

* UI tweaks

* fixed build issues and made added question to top of spreadsheets

* adds refreshSheets and added empty survey/spreadsheets text

* restored pnpm-lock

* added duplicate sheet warning

* move process.env to t3env

* move migration

* update docs link, add note to show that sheets integration is not configured

* Add simple docs page for google-sheets

* added session check

* restored pnpm-lock

* Merge branch 'main' of github.com:formbricks/formbricks into Integration/Google-sheet

* added google sheet  env variables to runtimeEnv

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-19 22:29:11 +09:00
ShubhamPalriwala
13bc73b47e feat: add missing seo metadata in landing pages 2023-09-18 18:30:38 +05:30
Anshuman Pandey
892776c493 refactor: moves team settings to server components (#693)
* feat: moves edit team name to server components

* feat: server components for membership roles

* feat: adds server actions and services

* fix: fixes invite server action

* feat: adds packages for jwt and email

* feat: server actions

* feat: moves edit memberships logic to server components

* feat: moves delete team logic to server components

* fix: fixes team loading states

* rename getAllMembershipsByUserId -> getMembershipsByUserId

* remove cache from mutating functions

* remove cache from updateInvite

* refactoring

* fix build error

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-18 17:32:42 +09:00
Johannes
22c2934969 chore: Add Requestly to OSS Friends
chore: Add Requestly to OSS Friends
2023-09-18 08:43:07 +02:00
Johannes
21edd7a3fc Chore: Remove Careers Page
Chore: Remove Careers Page
2023-09-18 08:42:45 +02:00
tyjkerr
bf67af4dca feat: Make response notes resolvable (#801)
* update notes ux

* add capability to resolve notes

* add migration

* update text color

* prevent updating unchanged note

* add isEdited to ResponseNote

* combine migrations into one

* simplify services

* fix UI issues

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-18 12:34:16 +09:00
Sachin Jain
31cace79c8 Add Requestly to OSS Friends 2023-09-17 20:04:52 +00:00
Johannes
0b7edfd115 remove careers page 2023-09-17 18:30:57 +02:00
Johannes
3b0f16878d chore: add openstatus to friends
chore: add openstatus to friends
2023-09-17 17:49:57 +02:00
Matti Nannt
9d1ea819c5 feat: add mau limit to web-app survey (#828) 2023-09-17 22:57:47 +09:00
Matti Nannt
ac11537e07 fix: make sure event listeners are only added once in formbricks-js (#825)
* add singleton pattern for js widget

* make sure event listeners are only initiated once
2023-09-17 22:51:40 +09:00
Thibault Le Ouay
43a3a0da75 add openstatus to friends 2023-09-17 10:04:56 +02:00
Matti Nannt
9a6a75056c fix: invalidate attributeClasses cache on create (#824) 2023-09-17 00:38:03 +09:00
Matti Nannt
f313275a14 fix: sync call gets called by other functions (#823)
* fix: sync call gets called by other functions

* fix: sync call gets called by other functions

* remove unused imports

* remove unused import

* fix userId update
2023-09-17 00:31:38 +09:00
Anshuman Pandey
d8b14f5f35 chore: add caching to js actions endpoint (#822)
* fix: caching in actions endpoint

* refactor

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-16 22:35:50 +09:00
Matti Nannt
e86b80cf0f chore: enable caching in all js endpoints to reduce database calls (#821)
* Move cached functions to services, add new caching to set-attribute

* update set-user-id route

* move remaining cache functions to services, simplify revalidation and keys

* simplify set-attribute further

* fix build errors

* comment out prisma client logging
2023-09-16 20:53:31 +09:00
Matti Nannt
b04acae0ba fix: formatting issue and build error (#820) 2023-09-16 16:05:12 +09:00
Matti Nannt
73ba6feec2 refactor: Add caching to the sync endpoint (#819)
* test: caching strategies

* feat: caching

* remove hotfix code

* remove unused import

* fix: adds revalidation to action services

* add environments to product service & type

* fix: fixes caching

* fix: fixes product cache

* add person revalidation to person js endpoints

* update surveys cache rule

* add new caching policy for surveys in sync

---------

Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com>
2023-09-16 15:53:44 +09:00
Shubham Palriwala
4a3289d394 chore: rewrite survey not found page to new nextjs standards (#807)
* feat: nextjs custom 404 page notFound

* type survey type properly and return unused inactive screen states

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-15 23:47:33 +09:00
Shubham Palriwala
75323800ea chore: upgrade to nextjs 13.4.19 (#817) 2023-09-15 18:37:42 +09:00
Anshuman Pandey
3fb3baf75d refactor: move product settings page to server components (#679)
* feat: moves edit product name to server component and actions

* feat: moves edit waiting time component to server

* feat: moves product settings to server components

* feat: moves delete product to server components

* fix: fixes delete product

* fix: server fixes

* fix: fixes loading state

* fix: fixes type

* fix: fixes membership types

* fix: fixes

* fix: changes and fixes

* fix build errors

* remove duplicate membership types

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-15 18:26:57 +09:00
Dhruwang Jariwala
e741f7d8e5 refactor: Move Onboarding to server components (#816)
* added data fetching to server side and also added some actions

* made refactors

* replaced router.push with redirect

* updated profileUpdateInput

* move components in components folder

* update import for product update action

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-15 11:58:00 +09:00
Dhruwang Jariwala
041bf36f20 refactor: add proper types to jwt service (#815) 2023-09-15 10:06:41 +09:00
Matti Nannt
4e5c822bec feat: fix prisma accelerate types (#812)
* Fix prisma client types;

* Undo ungraceful changes to the sync route with a more graceful cloud-only fix.

* update prisma runtime
2023-09-14 12:21:21 +09:00
Shubham Palriwala
05be97f43b feat: Introduces Source to the Webhook Overview for automatically created webhooks (#724)
* feat: webhooks now have a source to diff between user and third party

* fix: capitalise first letter of source and increase vertical padding in row

* fix: update webhhok source type in prisma and cleanup services

* combine two migrations into one

* add actions file for webhook UI

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-14 11:33:47 +09:00
ShubhamPalriwala
9c00e7ac20 Merge branch 'shubham/for-1150-validate-survey-editor-forms' of https://github.com/formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-09-14 07:34:49 +05:30
ShubhamPalriwala
4b838b26bc Merge branch 'main' of https://github.com/formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-09-14 07:33:53 +05:30
Matti Nannt
fa0d4ab83c feat: add prisma accelerate support (#810) 2023-09-14 04:02:11 +09:00
Matti Nannt
a60ff93754 temporarily deactivate sync endpoint (#809) 2023-09-14 01:50:33 +09:00
Matti Nannt
1a5e5fc845 make sync endpoint unavailable (#808) 2023-09-14 01:38:51 +09:00
Dhruwang Jariwala
993346b9ae chore: rewrite survey editor to server components (#728)
* created a new service for survey data mutation

* made requested changes

* made some refactors

* ran pnpm format

* removed console logs

* removed some unused code

* made upateSurvey return TSurvey and added laoding state to AddNoCodeActionModal

* fixed minor bugs

* ran pnpm format

* fixed build issues

* Replaced old question types with new types

* fix survey list not up to date on changes

* solved back button issue

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-13 18:30:50 +09:00
Tanmay Banage
ffef88731d fix: Fix string gets converted to date causing validation error (#793) 2023-09-13 13:01:48 +09:00
Dhruwang Jariwala
4f4e95fecb refactor: Added input validation using zod (#790)
* added input validation using zod

* changed console.log to console.error

* fix formatting issues

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-13 12:59:37 +09:00
Anshuman Pandey
50d7c9666c fix: fixes github sign up invite token (#803) 2023-09-13 11:54:40 +09:00
Dhruwang Jariwala
b7a97d9eb1 fix: Stop Sync in formbricks-js after logout() (#806)
* fixes logout() bug

* restored interval time
2023-09-13 11:50:18 +09:00
Anshuman Pandey
c7389ab3c6 fix: multiple smaller bugfixes (#805)
* fix: very small bugs

* fix: fixes white space bug
2023-09-13 11:40:06 +09:00
Piyush Gupta
be5f741ec7 fixed pnpm-lock file 2023-09-13 00:10:31 +05:30
Piyush Gupta
92e2abe6e4 resolved merge conflicts 2023-09-13 00:07:02 +05:30
Piyush Gupta
2cacba0b2f synced with main 2023-09-12 23:54:56 +05:30
Matti Nannt
ff51f2f25d chore: format code and fix lint workflow (#804) 2023-09-12 18:20:09 +09:00
Dhruwang Jariwala
6a88420122 feat: Add Make.com integration (#628)
* added documentation for make.com integration

* ran pnpm format

* update wording in docs

* updated docs for make integration

* updated connect link

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-12 18:05:52 +09:00
Dhruwang Jariwala
1be6deec64 chore: Rewrite environment navbar to server components (#690)
* moved environment navbar to RSC

* added Error component

* format

* update errors path

* use standard services in environment navbar, update product service according to standards, add redirect shortcuts for teams and products

* update analysis github workflow with environment variables

* fix WEBAPP_URL is required

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-12 14:15:03 +09:00
Shubham Palriwala
cbc649111c fix: survey base not set correctly in docker setup (#802) 2023-09-12 13:27:10 +09:00
Shubham Palriwala
60ac49b5c2 fix: webhooks fetch cache is not getting invalidated (#800) 2023-09-11 23:39:51 +09:00
github-actions[bot]
d0310fc243 Release formbricks-js 1.0.6 (#796)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-09-11 16:06:24 +09:00
Matti Nannt
8efb1054dd fix: issue in responseQueue that could lead to a response sent twice (#795)
* fix: responseQueue may be executed twice

* release new formbricks-js version

* update bundle analysis
2023-09-11 16:03:14 +09:00
Matti Nannt
f1688502a2 chore: Update npm package dependencies (#794)
* upgrade packages

* upgrade packages in demo & formbricks-com

* update web packages
2023-09-11 15:05:55 +09:00
Shubham Palriwala
3a202541d0 remove: @formbricks/errors (#784) 2023-09-11 10:29:12 +09:00
Matti Nannt
686b52fd14 chore: format code based on prettier rules (#792) 2023-09-10 17:15:43 +09:00
Kuluru Vineeth Kumar Reddy
7d11856f14 feat: response notes can now be edited (#716)
* - Feature Enhancement : Edit and Resolve Notes

* Merge branch 'main' of github.com:formbricks/formbricks into feature/updateNote

* update pencil icon

* - added editing the notes functionality in responses

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-10 17:13:59 +09:00
Matti Nannt
ab668c307b fix: link survey responses may fail when custom survey url is set (#791) 2023-09-10 14:33:04 +09:00
Matti Nannt
0a08d7df68 chore: Introduce unified survey UI package @formbricks/surveys (#698)
* add vite survey package

* add renderSurvey method

* add all survey components

* First working version of renderSurvey

* integrate survey package into survey preview

* add survey modal functionality to formbricks-surveys

* fix build errors and add new template types

* add response queue

* add simple formbricks-js integration

* add local state management for surveys

* add local storage to multiple choice and open text questions

* add local state to other question types, layout fixes

* Fix modal close button, clean js package code

* add new calculate progress function

* fix progressbar on thankyou card

* fix churn survey branching in demo product

* use tsup to bundle @formbricks/js

* update survey positioning in link surveys

* fix preview reset button in link survey

* change logic for progress bar

* update progressbar logic

* update spacing

* add conditional autofocus / disable for iframe

* add userId to link survey

* integrated email verification

* moved token verification and reading to server component

* ran pnpm format

* added question prefilling

* ran pnpm format

* Moved question prefilling logic to Link Survey

* Refactor types

* centralize survey package props, fix build errors

* fix userId in link survey

* fix survey closed message

* add redirect on complete, fix bugs

* smaller bugfixes

* smaller bugfixes

* fix bugs

* fix build errors

* remove logs

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
2023-09-10 14:06:55 +09:00
Piyush Gupta
5cb31fbe2a feat: added embed survey modal 2023-09-10 02:01:30 +05:30
Matti Nannt
bf6ed3576c feat: Add option to customize link survey url using NEXT_PUBLIC_SURVEY_BASE_URL (#787) 2023-09-08 14:01:56 +09:00
Johannes
38092f8a7c fix: (docs) n8n page heading bug and responsiveness issues
fix: (docs) n8n page heading bug and responsiveness issues
2023-09-07 18:57:32 +02:00
ShubhamPalriwala
d290b6e011 fix: (docs) n8n page heading bug and responsiveness issues 2023-09-07 21:55:05 +05:30
Shubham Palriwala
c901ab13f5 fix: build error in formbricks-com when STRAPI_API_KEY not set (#785) 2023-09-07 23:21:24 +09:00
Shubham Palriwala
ae5d3f8e71 Merge branch 'main' into shubham/for-1150-validate-survey-editor-forms 2023-09-07 00:21:26 +05:30
ShubhamPalriwala
50369afd85 fix: only highlight the incorrect choice in multi 2023-09-07 00:20:23 +05:30
ShubhamPalriwala
e49cfca56a fix: dont allow is skipped on reqd question, and show approporiate toast error 2023-09-07 00:13:58 +05:30
ShubhamPalriwala
284361aaba fix: corner cases for new option empty and duplicates in single and multi select 2023-09-06 23:33:15 +05:30
Dhruwang Jariwala
0a1de196aa chore: moves setup checklist to react server components (#695)
* Chore: moves setup checklist to RSC

* fix other merge conflictsg

* made code refactors

* added TAction as return type for getActions

* fixed build issues

* fix environmentNotice component

* refactor EnvironmentNotice component

* fix js tests

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-06 15:18:49 +09:00
Shubham Palriwala
b0d7bd8686 feat: add email setup to single script prod setup (#752) 2023-09-06 13:32:46 +09:00
Dhruwang Jariwala
6a121680ba feat: Add ability to change back button label (#753)
* adds back button label adjust

* update wording

* made some refactors

---------

Co-authored-by: Johannes <johannes@formbricks.com>
Co-authored-by: Dhruwang Jariwala <dhruwang@Dhruwangs-MacBook-Pro.local>
Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-06 13:29:44 +09:00
Shubham Palriwala
edc8870e09 chore: Add Missing Environment Variables in Documentation (#754)
* fix: remove unused stripe_public_key env var

* feat: include all possible env vars in documentation

* update enviroment variables in docs

---------

Co-authored-by: Matthias Nannt <mail@matthiasnannt.com>
2023-09-06 13:26:28 +09:00
ShubhamPalriwala
4320e36ed3 fix: entire questions get red when a field is invalid, now only the field gets red unless trying to save 2023-09-04 18:46:18 +05:30
Johannes
877ab1fd39 Update wording 2023-09-04 11:15:57 +02:00
Johannes
f75b74d38e Merge branch 'main' of github.com:formbricks/formbricks into shubham/for-1150-validate-survey-editor-forms 2023-09-04 10:37:48 +02:00
ShubhamPalriwala
941527151f fix: multi option multi choose can now not have same options 2023-09-01 16:53:50 +05:30
ShubhamPalriwala
59fb26a6fa fix: setting duplicate question Ids now does not set random ID when click saved, the user has to update it 2023-09-01 16:27:29 +05:30
ShubhamPalriwala
632bab40f3 fix: user cannot select a skipped logic for a required question 2023-09-01 12:52:03 +05:30
ShubhamPalriwala
cc9142e89b fix: user can now cannot 2 exactly same logic conditions 2023-08-31 21:08:56 +05:30
ShubhamPalriwala
bca1e0e926 fix: not allow new logic jump until previous filled & do not allow saving survey until atleast 2 fields are filled 2023-08-31 20:57:45 +05:30
ShubhamPalriwala
b7d4885e51 fix: long single word was overflowing the thank you card 2023-08-30 13:11:24 +05:30
ShubhamPalriwala
00494a7093 fix: multi option single choose can now not have same options 2023-08-29 23:08:09 +05:30
ShubhamPalriwala
6dfc75a4ce fix: consent question's checkbox should now have some text or default text mandatory 2023-08-29 19:42:17 +05:30
ShubhamPalriwala
c10854523d fix: it is now not allowed to save/publish a survey with 0 responses 2023-08-29 19:16:42 +05:30
925 changed files with 33181 additions and 21701 deletions

View File

@@ -1,103 +0,0 @@
########################################################################
# ------------ MANDATORY (CHANGE ACCORDING TO YOUR SETUP) ------------#
########################################################################
############
# BASICS #
############
NEXT_PUBLIC_WEBAPP_URL=http://localhost:3000
##############
# DATABASE #
##############
DATABASE_URL='postgresql://postgres:postgres@postgres:5432/formbricks?schema=public'
# Uncomment to enable a dedicated connection pool for Prisma using Prisma Data Proxy
# Cold boots will be faster and you'll be able to scale your DB independently of your app.
# @see https://www.prisma.io/docs/data-platform/data-proxy/use-data-proxy
# PRISMA_GENERATE_DATAPROXY=true
PRISMA_GENERATE_DATAPROXY=
###############
# NEXT AUTH #
###############
# @see: https://next-auth.js.org/configuration/options#nextauth_secret
# You can use: `openssl rand -base64 32` to generate one
NEXTAUTH_SECRET=RANDOM_STRING
# Set this to your public-facing URL, e.g., https://example.com
# You do not need the NEXTAUTH_URL environment variable in Vercel.
NEXTAUTH_URL=http://localhost:3000
# If you encounter NEXT_AUTH URL problems this should always be localhost:3000 (or whatever port your app is running on)
# NEXTAUTH_URL_INTERNAL=http://localhost:3000
################
# MAIL SETUP #
################
# Necessary if email verification and password reset are enabled.
# See optional configurations below if you want to disable these features.
# MAIL_FROM=noreply@example.com
# SMTP_HOST=localhost
# SMTP_PORT=1025
# Enable SMTP_SECURE_ENABLED for TLS (port 465)
# SMTP_SECURE_ENABLED=0
# SMTP_USER=smtpUser
# SMTP_PASSWORD=smtpPassword
########################################################################
# ------------------------------ OPTIONAL -----------------------------#
########################################################################
# Uncomment the variables you would like to use and customize the values.
#####################
# Disable Features #
#####################
# Email Verification. If you enable Email Verification you have to setup SMTP-Settings, too.
NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED=1
# Password Reset. If you enable Password Reset functionality you have to setup SMTP-Settings, too.
NEXT_PUBLIC_PASSWORD_RESET_DISABLED=1
# Signup. Disable the ability for new users to create an account.
# NEXT_PUBLIC_SIGNUP_DISABLED=1
# Team Invite. Disable the ability for invited users to create an account.
# NEXT_PUBLIC_INVITE_DISABLED=1
##########
# Other #
##########
# Display privacy policy, imprint and terms of service links in the footer of signup & public pages.
NEXT_PUBLIC_PRIVACY_URL=
NEXT_PUBLIC_TERMS_URL=
NEXT_PUBLIC_IMPRINT_URL=
# Disable Sentry warning
SENTRY_IGNORE_API_RESOLUTION_ERROR=1
# Enable Sentry Error Tracking
NEXT_PUBLIC_SENTRY_DSN=
# Configure Github Login
NEXT_PUBLIC_GITHUB_AUTH_ENABLED=0
GITHUB_ID=
GITHUB_SECRET=
# Configure Google Login
NEXT_PUBLIC_GOOGLE_AUTH_ENABLED=0
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
# Cron Secret
CRON_SECRET=

View File

@@ -1,3 +1,4 @@
/*
########################################################################
# ------------ MANDATORY (CHANGE ACCORDING TO YOUR SETUP) ------------#
########################################################################
@@ -7,7 +8,21 @@
# BASICS #
############
NEXT_PUBLIC_WEBAPP_URL=http://localhost:3000
WEBAPP_URL=http://localhost:3000
SURVEY_BASE_URL=http://localhost:3000/s
# Set this if you want to have a shorter link for surveys
SHORT_SURVEY_BASE_URL=
# Encryption keys
# Please set both for now, we will change this in the future
# You can use: `openssl rand -base64 16` to generate one
FORMBRICKS_ENCRYPTION_KEY=
# You can use: `openssl rand -base64 24` to generate one
ENCRYPTION_KEY=
##############
# DATABASE #
@@ -15,12 +30,6 @@ NEXT_PUBLIC_WEBAPP_URL=http://localhost:3000
DATABASE_URL='postgresql://postgres:postgres@localhost:5432/formbricks?schema=public'
# Uncomment to enable a dedicated connection pool for Prisma using Prisma Data Proxy
# Cold boots will be faster and you'll be able to scale your DB independently of your app.
# @see https://www.prisma.io/docs/data-platform/data-proxy/use-data-proxy
# PRISMA_GENERATE_DATAPROXY=true
PRISMA_GENERATE_DATAPROXY=
###############
# NEXT AUTH #
###############
@@ -33,9 +42,6 @@ NEXTAUTH_SECRET=RANDOM_STRING
# You do not need the NEXTAUTH_URL environment variable in Vercel.
NEXTAUTH_URL=http://localhost:3000
# If you encounter NEXT_AUTH URL problems this should always be localhost:3000 (or whatever port your app is running on)
# NEXTAUTH_URL_INTERNAL=http://localhost:3000
################
# MAIL SETUP #
################
@@ -63,39 +69,43 @@ SMTP_PASSWORD=smtpPassword
#####################
# Email Verification. If you enable Email Verification you have to setup SMTP-Settings, too.
# NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED=1
# EMAIL_VERIFICATION_DISABLED=1
# Password Reset. If you enable Password Reset functionality you have to setup SMTP-Settings, too.
# NEXT_PUBLIC_PASSWORD_RESET_DISABLED=1
# PASSWORD_RESET_DISABLED=1
# Signup. Disable the ability for new users to create an account.
# NEXT_PUBLIC_SIGNUP_DISABLED=1
# SIGNUP_DISABLED=1
# Team Invite. Disable the ability for invited users to create an account.
# NEXT_PUBLIC_INVITE_DISABLED=1
# INVITE_DISABLED=1
##########
# Other #
##########
# Display privacy policy, imprint and terms of service links in the footer of signup & public pages.
NEXT_PUBLIC_PRIVACY_URL=
NEXT_PUBLIC_TERMS_URL=
NEXT_PUBLIC_IMPRINT_URL=
PRIVACY_URL=
TERMS_URL=
IMPRINT_URL=
# Configure Github Login
NEXT_PUBLIC_GITHUB_AUTH_ENABLED=0
GITHUB_AUTH_ENABLED=0
GITHUB_ID=
GITHUB_SECRET=
# Configure Google Login
NEXT_PUBLIC_GOOGLE_AUTH_ENABLED=0
GOOGLE_AUTH_ENABLED=0
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
# Cron Secret
CRON_SECRET=
# Configure this when you want to ship JS & CSS files from a complete URL instead of the current domain
# ASSET_PREFIX_URL=
# Stripe Billing Variables
NEXT_PUBLIC_STRIPE_PUBLIC_KEY=
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=
@@ -104,5 +114,4 @@ NEXT_PUBLIC_FORMBRICKS_API_HOST=
NEXT_PUBLIC_FORMBRICKS_ENVIRONMENT_ID=
NEXT_PUBLIC_FORMBRICKS_ONBOARDING_SURVEY_ID=
# Cron Secret
CRON_SECRET=
*/

View File

@@ -4,42 +4,45 @@ title: "[FEATURE]"
labels: enhancement
assignees: []
body:
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution-description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternate-solution-description
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: markdown
id: formbricks-info
attributes:
value: |
### How we code at Formbricks 🤓
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution-description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternate-solution-description
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: markdown
id: formbricks-info
attributes:
value: |
### How we code at Formbricks 🤓
- Everything is type-safe
- All UI components are in the package `formbricks/ui`
- Run `pnpm dev` to find a demo app to test in-app surveys at `localhost:3002`
- We use **chatGPT** to help refactor code. Use our [Formbricks ✨ megaprompt ✨](https://github.com/formbricks/formbricks/blob/main/megaprompt.md) to create the right
context before you write your prompt.
- Follow Best Practices lined out in our [Contributor Docs](https://formbricks.com/docs/contributing/how-we-code)
- First time: Please read our [introductory blog post](https://formbricks.com/blog/join-the-formtribe)
- All UI components are in the package `formbricks/ui`
- Run `pnpm go` to find a demo app to test in-app surveys at `localhost:3002`
- Everything is type-safe
- We use **chatGPT** to help refactor code. Use our [Formbricks ✨ megaprompt ✨](https://github.com/formbricks/formbricks/blob/main/megaprompt.md) to create the right
context before you write your prompt.
- Anything unclear? [Ask in Discord](https://formbricks.com/discord)

View File

@@ -31,9 +31,10 @@ Fixes # (issue)
<!-- We're starting to get more and more contributions. Please help us making this efficient for all of us and go through this checklist. Please tick off what you did -->
- [ ] Added a screen recording or screenshots to this PR
### Required
- [ ] Filled out the "How to test" section in this PR
- [ ] Read the [contributing guide](https://github.com/formbricks/formbricks/blob/main/CONTRIBUTING.md)
- [ ] Read [How we Code at Formbricks](<[https://github.com/formbricks/formbricks/blob/main/CONTRIBUTING.md](https://formbricks.com/docs/contributing/how-we-code)>)
- [ ] Self-reviewed my own code
- [ ] Commented on my code in hard-to-understand bits
- [ ] Ran `pnpm build`
@@ -41,4 +42,8 @@ Fixes # (issue)
- [ ] Removed all `console.logs`
- [ ] Merged the latest changes from main onto my branch with `git pull origin main`
- [ ] My changes don't cause any responsiveness issues
### Appreciated
- [ ] If a UI change was made: Added a screen recording or screenshots to this PR
- [ ] Updated the Formbricks Docs if changes were necessary

View File

@@ -1,27 +1,23 @@
name: Tests
name: Build
on:
workflow_call:
jobs:
build:
name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
name: Build Formbricks-web
runs-on: ubuntu-latest
timeout-minutes: 30
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
steps:
- name: Checkout repo
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Setup Node.js 18.x
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 18.x
- name: Install pnpm
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v2
- name: Install dependencies
run: pnpm install --config.platform=linux --config.architecture=x64
@@ -29,5 +25,10 @@ jobs:
- name: create .env
run: cp .env.example .env
- name: Build formbricks-js dependencies
- name: Generate Random NEXTAUTH_SECRET
run: |
SECRET=$(openssl rand -base64 24)
echo "ENCRYPTION_KEY=$SECRET" >> $GITHUB_ENV
- name: Build Formbricks-web
run: pnpm build --filter=web...

View File

@@ -6,6 +6,7 @@ concurrency:
cancel-in-progress: true
jobs:
labeler:
name: Pull Request Labeler
permissions:
contents: read
pull-requests: write

View File

@@ -3,28 +3,32 @@ on:
workflow_call:
jobs:
build:
name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
name: Linters
runs-on: ubuntu-latest
timeout-minutes: 15
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
steps:
- name: Checkout repo
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Setup Node.js 18.x
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 18.x
- name: Install pnpm
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v2
- name: Install dependencies
run: pnpm install --config.platform=linux --config.architecture=x64
- name: create .env
run: cp .env.example .env
- name: Generate Random NEXTAUTH_SECRET
run: |
SECRET=$(openssl rand -base64 24)
echo "ENCRYPTION_KEY=$SECRET" >> $GITHUB_ENV
- name: Lint
run: pnpm lint

View File

@@ -1,118 +0,0 @@
name: "Next.js Bundle Analysis"
on:
workflow_call:
push:
branches:
- main
jobs:
build:
name: Production build
if: ${{ github.event_name == 'push' }}
uses: ./.github/workflows/build-production.yml
secrets: inherit
analyze:
needs: build
if: always()
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v2
- name: Setup Node.js 18.x
uses: actions/setup-node@v2
with:
node-version: 18.x
- name: Install pnpm
uses: pnpm/action-setup@v2.2.4
- name: Install dependencies
run: pnpm install --config.platform=linux --config.architecture=x64
- name: create .env
run: cp .env.example .env
- name: Build formbricks-js dependencies
run: pnpm build --filter=web...
- name: Upload bundle
uses: actions/upload-artifact@v2
with:
name: bundle
path: apps/web/.next/analyze/__bundle_analysis.json
- name: Analyze bundle
run: |
cd apps/web
npx -p nextjs-bundle-analysis@0.5.0 report
- name: Upload bundle
uses: actions/upload-artifact@v2
with:
name: bundle
path: apps/web/.next/analyze/__bundle_analysis.json
- name: Download base branch bundle stats
uses: dawidd6/action-download-artifact@v2
if: success() && github.event.number
with:
workflow: nextjs-bundle-analysis.yml
branch: ${{ github.event.pull_request.base.ref }}
path: apps/web/.next/analyze/base
# And here's the second place - this runs after we have both the current and
# base branch bundle stats, and will compare them to determine what changed.
# There are two configurable arguments that come from package.json:
#
# - budget: optional, set a budget (bytes) against which size changes are measured
# it's set to 350kb here by default, as informed by the following piece:
# https://infrequently.org/2021/03/the-performance-inequality-gap/
#
# - red-status-percentage: sets the percent size increase where you get a red
# status indicator, defaults to 20%
#
# Either of these arguments can be changed or removed by editing the `nextBundleAnalysis`
# entry in your package.json file.
- name: Compare with base branch bundle
if: success() && github.event.number
run: |
cd apps/web
ls -laR .next/analyze/base && npx -p nextjs-bundle-analysis compare
- name: Get comment body
id: get-comment-body
if: success() && github.event.number
run: |
cd apps/web
body=$(cat .next/analyze/__bundle_analysis_comment.txt)
body="${body//'%'/'%25'}"
body="${body//$'\n'/'%0A'}"
body="${body//$'\r'/'%0D'}"
echo ::set-output name=body::$body
- name: Find Comment
uses: peter-evans/find-comment@v1
if: success() && github.event.number
id: fc
with:
issue-number: ${{ github.event.number }}
body-includes: "<!-- __NEXTJS_BUNDLE_@calcom/web -->"
- name: Create Comment
uses: peter-evans/create-or-update-comment@v1.4.4
if: success() && github.event.number && steps.fc.outputs.comment-id == 0
with:
issue-number: ${{ github.event.number }}
body: ${{ steps.get-comment-body.outputs.body }}
- name: Update Comment
uses: peter-evans/create-or-update-comment@v1.4.4
if: success() && github.event.number && steps.fc.outputs.comment-id != 0
with:
issue-number: ${{ github.event.number }}
body: ${{ steps.get-comment-body.outputs.body }}
comment-id: ${{ steps.fc.outputs.comment-id }}
edit-mode: replace

View File

@@ -4,9 +4,6 @@ on:
pull_request_target:
branches:
- main
paths-ignore:
- "**.md"
- ".github/CODEOWNERS"
merge_group:
workflow_dispatch:
@@ -16,27 +13,22 @@ concurrency:
jobs:
test:
name: Unit tests
name: Run Tests
uses: ./.github/workflows/test.yml
secrets: inherit
lint:
name: Linters
name: Run Linters
uses: ./.github/workflows/lint.yml
secrets: inherit
build-production:
name: Production build (without database)
uses: ./.github/workflows/build-production.yml
secrets: inherit
analyze:
needs: build-production
uses: ./.github/workflows/nextjs-bundle-analysis.yml
build:
name: Build Formbricks-web
uses: ./.github/workflows/build.yml
secrets: inherit
required:
needs: [lint, test, build-production]
needs: [lint, test, build]
if: always()
runs-on: ubuntu-latest
steps:

View File

@@ -12,7 +12,18 @@ jobs:
env:
TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
DATABASE_URL: "postgresql://postgres:postgres@localhost:5432/formbricks?schema=public"
steps:
- name: Generate Random NEXTAUTH_SECRET
run: |
SECRET=$(openssl rand -hex 16)
echo "NEXTAUTH_SECRET=$SECRET" >> $GITHUB_ENV
- name: Generate Random NEXTAUTH_SECRET
run: |
SECRET=$(openssl rand -base64 24)
echo "ENCRYPTION_KEY=$SECRET" >> $GITHUB_ENV
- name: Checkout Repo
uses: actions/checkout@v2
@@ -41,3 +52,6 @@ jobs:
tags: |
${{ secrets.DOCKER_USERNAME }}/formbricks:${{ env.RELEASE_TAG }}
${{ secrets.DOCKER_USERNAME }}/formbricks:latest
build-args: |
NEXTAUTH_SECRET=${{ env.NEXTAUTH_SECRET }}
DATABASE_URL=${{ env.DATABASE_URL }}

View File

@@ -1,4 +1,4 @@
name: "Validate PRs"
name: "Check PR"
on:
pull_request_target:
@@ -13,7 +13,7 @@ permissions:
jobs:
validate-pr:
name: Validate PR title
name: PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5

View File

@@ -3,7 +3,7 @@ on:
workflow_call:
jobs:
build:
name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
name: Tests
runs-on: ubuntu-latest
timeout-minutes: 15
@@ -13,15 +13,15 @@ jobs:
steps:
- name: Checkout repo
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Setup Node.js 18.x
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 18.x
- name: Install pnpm
uses: pnpm/action-setup@v2.2.4
uses: pnpm/action-setup@v2
- name: Install dependencies
run: pnpm install --config.platform=linux --config.architecture=x64

View File

@@ -32,8 +32,12 @@ tasks:
command: |
gp sync-await init &&
cp .env.example .env &&
sed -i -r "s#^(NEXT_PUBLIC_WEBAPP_URL=).*#\1 $(gp url 3000)#" .env &&
sed -i -r "s#^(WEBAPP_URL=).*#\1 $(gp url 3000)#" .env &&
sed -i -r "s#^(NEXTAUTH_URL=).*#\1 $(gp url 3000)#" .env &&
RANDOM_FORMBRICKS_ENCRYPTION_KEY=$(openssl rand -base64 16)
sed -i 's/^FORMBRICKS_ENCRYPTION_KEY=.*/FORMBRICKS_ENCRYPTION_KEY='"$RANDOM_FORMBRICKS_ENCRYPTION_KEY"'/' .env
RANDOM_ENCRYPTION_KEY=$(openssl rand -base64 24)
sed -i 's/^ENCRYPTION_KEY=.*/ENCRYPTION_KEY='"$RANDOM_ENCRYPTION_KEY"'/' .env
turbo --filter "@formbricks/web" go
image:
@@ -57,7 +61,7 @@ ports:
onOpen: ignore
- port: 8025
visibility: public
onOpen: ignore
onOpen: open-browser
github:
prebuilds:

View File

@@ -29,6 +29,14 @@
<a href="https://neverinstall.com/"><img src="https://github.com/formbricks/formbricks/assets/675065/72e5e37b-8ef7-4340-b06e-f1d12a05330f#gh-light-mode-only" height="20px"></a><a href="https://neverinstall.com/"><img src="https://github.com/formbricks/formbricks/assets/72809645/9d9711dc-75e5-4084-b7fa-bbaf621064a8#gh-dark-mode-only" height="20px">
</p>
<img width="1527" alt="formtribe hackathon" src="https://github.com/formbricks/formbricks/assets/72809645/addc3a5b-421c-4c8d-8be2-eedf087100ed">
## 🔥 The FormTribe Hackathon is on!
To celebrate Hacktoberfest, we've launched our FormTribe hackathon. Write code or perform non-code side quests to collect points and increase your chances of winning the MacBook Air M2!
**Join lottery with a [single tweet!](https://formtribe.com). All info on [formtribe.com](https://formtribe.com)**
## ✨ About Formbricks
<img width="1527" alt="formbricks-sneak" src="https://github-production-user-asset-6210df.s3.amazonaws.com/675065/249441967-ccb89ea3-82b4-4bf2-8d2c-528721ec313b.png">
@@ -43,13 +51,13 @@ Formbricks helps you apply best practices from data-driven work and experience m
### Features
- 📲 Create **in-product surveys** with our no code editor with multiple question types
- 📚 Choose from a variety of best-practice **templates**
- 👩🏻 Launch and **target your surveys to specific user groups** without changing your application code
- 🔗 Create shareable **link surveys**
- 👨‍👩‍👦 Invite your team members to **collaborate** on your surveys
- 🔌 Integrate Formbricks with **Slack, Posthog, Zapier, n8n and more**
- 🔒 All **open source**, transparent and self-hostable
- 📲 Create **in-product surveys** with our no code editor with multiple question types.
- 📚 Choose from a variety of best-practice **templates**.
- 👩🏻 Launch and **target your surveys to specific user groups** without changing your application code.
- 🔗 Create shareable **link surveys**.
- 👨‍👩‍👦 Invite your team members to **collaborate** on your surveys.
- 🔌 Integrate Formbricks with **Slack, Posthog, Zapier, n8n and more**.
- 🔒 All **open source**, transparent and self-hostable.
### Built on Open Source
@@ -63,15 +71,53 @@ Formbricks helps you apply best practices from data-driven work and experience m
## 🚀 Getting started
We've got several options depending on your need to help you quickly get started with Formbricks.
### ☁️ Cloud Version
Formbricks has a hosted cloud offering with a generous free plan to get you up and running as quickly as possible. To get started, please visit [formbricks.com](https://formbricks.com)
Formbricks has a hosted cloud offering with a generous free plan to get you up and running as quickly as possible. To get started, please visit [formbricks.com](https://formbricks.com).
### 🐳 Self-hosted version
Formbricks is available Open-Source under AGPLv3 license. You can host Formbricks on your own servers using Docker without a subscription. To get started with self-hosting, take a look at our [self-hosting docs](https://formbricks.com/docs/self-hosting/deployment).
Formbricks is available Open-Source under AGPLv3 license. You can host Formbricks on your own servers using Docker without a subscription.
(In the future we may develop additional features that aren't in the free Open-Source version)
(In the future we may develop additional features that aren't in the free Open-Source version).
If you opt for self-hosting Formbricks, here are a few options to consider:
#### Docker
To get started with self-hosting with Docker, take a look at our [self-hosting docs](https://formbricks.com/docs/self-hosting/deployment).
#### Community managed One Click Hosting
##### Railway
You can deploy Formbricks on [Railway](https://railway.app) using the button below.
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/PPDzCd)
### 👨‍💻 Development
#### Prerequisites
Here is what you need to be able to run Formbricks:
- [Node.js](https://nodejs.org/en) (Version: >=18.x)
- [Pnpm](https://pnpm.io/)
- [Docker](https://www.docker.com/) - to run PostgreSQL and MailHog
#### Local Setup
To get started locally, we've got a [guide to help you](https://formbricks.com/docs/contributing/setup).
#### Gitpod Setup
1. Click the button below to open this project in Gitpod.
2. This will open a fully configured workspace in your browser with all the necessary dependencies already installed.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/formbricks/formbricks)
## ✍️ Contribution
@@ -79,12 +125,18 @@ We are very happy if you are interested in contributing to Formbricks 🤗
Here are a few options:
- Star this repo
- Create issues every time you feel something is missing or goes wrong
- Upvote issues with 👍 reaction so we know what's the demand for particular issue to prioritize it within roadmap
- Star this repo.
- Create issues every time you feel something is missing or goes wrong.
- Upvote issues with 👍 reaction so we know what's the demand for a particular issue to prioritize it within the roadmap.
Please check out [our contribution guide](https://formbricks.com/docs/contributing/introduction) and our [list of open issues](https://github.com/formbricks/formbricks/issues) for more information.
## All Thanks To Our Contributors
<a href="https://github.com/formbricks/formbricks/graphs/contributors">
<img src="https://contrib.rocks/image?repo=formbricks/formbricks" />
</a>
## 📆 Contact us
Let's have a chat about your survey needs and get you started.

View File

@@ -1,39 +1,75 @@
# Security
# Security Policy of Formbricks
Contact: security@formbricks.com
This is Formbrick's security policy. Please reach out to us
on our Discord or, if privately, via <security@formbricks.com>
Based on [https://supabase.com/.well-known/security.txt](https://supabase.com/.well-known/security.txt)
## Introduction
At Formbricks, we consider the security of our systems a top priority. But no matter how much effort we put into system security, there can still be vulnerabilities present.
Formbricks is dedicated to maintaining the integrity and security of our systems and our clients' data. In our pursuit to keep our technology environment safe, we welcome the collaborative efforts of our user community and security researchers to enhance security protocols and continuously secure our platform. This security policy outlines our approach towards handling data, ensuring secure practices, and managing the disclosure of vulnerabilities.
If you discover a vulnerability, we would like to know about it so we can take steps to address it as quickly as possible. We would like to ask you to help us better protect our clients and our systems.
## I. Third-Party Data Usage Policy
## Out of scope vulnerabilities:
We affirm our commitment towards meticulous validation of data usage and collection scope by any third-party library or integration utilized in our operations. We adhere to the following protocols:
- Clickjacking on pages with no sensitive actions.
- Unauthenticated/logout/login CSRF.
- Attacks requiring MITM or physical access to a user's device.
- Any activity that could lead to the disruption of our service (DoS).
- Content spoofing and text injection issues without showing an attack vector/without being able to modify HTML/CSS.
- Email spoofing
- Missing DNSSEC, CAA, CSP headers
- Lack of Secure or HTTP only flag on non-sensitive cookies
- Deadlinks
- Rigorous vetting of third-party services to confirm adherence to our data usage and privacy standards.
- Continuous monitoring and assessment of third-party practices to ensure ongoing compliance.
- Immediate action to mitigate risks if a third-party deviates from agreed-upon data practices.
## Please do the following:
## II. Annual Penetration Testing (Pentest)
- E-mail your findings to [security@formbricks.com](mailto:security@formbricks.com).
- Do not run automated scanners on our infrastructure or dashboard. If you wish to do this, contact us and we will set up a sandbox for you.
- Do not take advantage of the vulnerability or problem you have discovered, for example by downloading more data than necessary to demonstrate the vulnerability or deleting or modifying other people's data,
- Do not reveal the problem to others until it has been resolved,
- Do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties,
- Do provide sufficient information to reproduce the problem, so we will be able to resolve it as quickly as possible. Usually, the IP address or the URL of the affected system and a description of the vulnerability will be sufficient, but complex vulnerabilities may require further explanation.
To understand and bolster our security stature, Formbricks undertakes:
## What we promise:
- Annual penetration testing executed by an independent, skilled third party.
- Prioritization of any identified issues, with immediate action on critical vulnerabilities.
- Transparent communication and learnings shared with relevant stakeholders.
- We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date,
- If you have followed the instructions above, we will not take any legal action against you in regard to the report,
- We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission,
- We will keep you informed of the progress towards resolving the problem,
- In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise), and
- We strive to resolve all problems as quickly as possible, and we would like to play an active role in the ultimate publication on the problem after it is resolved.
## III. Vulnerability Reporting and Management
Please do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties.
### **A. When to Report a Vulnerability**
We invite you to report if:
- A potential security vulnerability in Formbricks is identified.
- There is uncertainty about how a vulnerability affects our platform.
- A vulnerability is detected in a dependent project of Formbricks.
- An action was executed which, in your belief, should be restricted.
### **B. When Reporting is Unnecessary**
Avoid reporting if:
- Assistance is needed to optimize Formbricks for security please engage on our Discord for this.
- Help is required for applying security-related updates.
- The concern is not related to security.
### **C. Vulnerability Reporting Procedure**
In the interest of responsibly managing vulnerabilities, please adhere to the following procedure:
> Do not reveal the problem to others until it has been resolved.
1. **Send a Detailed Report**:
- Address emails to [security@formbricks.com](mailto:security@formbricks.com).
- Include:
- Problem description.
- Detailed, reproducible steps, with screenshots where possible.
- Affected version(s).
- Known possible mitigations.
- Your Discord username or preferred contact method.
2. **Acknowledgement of Receipt**:
- Our security team will acknowledge receipt and provide an initial response within 48 hours.
- Following verification of the vulnerability and the fix, a release plan will be formulated, with the fix deployed between 7 to 28 days, depending on the severity and complexity.
3. **Ongoing Communication**:
- A project maintainer may engage with you for additional details or clarification.
- We appreciate your patience as we explore the reported item, verify its authenticity, and ascertain the existence of a vulnerability.
---
### Please Read the below carefully
If you have followed the instructions above, we will **not** take any legal action against you in regard to the report,
We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission, We will keep you informed of the progress towards resolving the problem, In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise).
We, at Formbricks, wish to express our gratitude towards all individuals who assist us in fortifying our security posture. Your responsible disclosure and cooperation enable us to elevate our security protocols, safeguarding our platform and data therein.

View File

@@ -13,7 +13,7 @@
"dependencies": {
"@formbricks/js": "workspace:*",
"@heroicons/react": "^2.0.18",
"next": "13.4.12",
"next": "13.5.4",
"react": "18.2.0",
"react-dom": "18.2.0"
},

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Code Actions",
title: "Implementing Code Actions in Formbricks | Real-time User Action Tracking",
description:
"Integrate code actions in Formbricks using formbricks.track() to trigger surveys based on user actions, like button clicks, for precise insights. All open-source.",
"Dive into the world of Formbricks' code actions. Learn how to seamlessly integrate formbricks.track() method into your codebase, enabling real-time tracking of user actions like button clicks, visiting a specfic URL. Up your survey game with precise and exact triggers.",
};
#### Actions
@@ -9,7 +9,7 @@ export const meta = {
# Code Actions
Actions can also be set in the code base. You can fire an action using `formbricks.track()`
<Col>
<CodeGroup title="Track an action">
```javascript
@@ -17,9 +17,9 @@ formbricks.track("Action Name");
```
</CodeGroup>
</Col>
Here is an example of how to fire an action when a user clicks a button:
<Col>
<CodeGroup title="Track Button Click">
```javascript
@@ -31,3 +31,4 @@ return <button onClick={handleClick}>Click Me</button>;
```
</CodeGroup>
</Col>

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "No-Code Actions",
title: "Implementing No-Code Actions in Formbricks | Real-time User Action Tracking",
description:
"Utilize Formbricks' No-Code Actions like Page URL, innerText, and CSS Selector for easy survey triggers and enhanced user insights.",
"Discover the power of Formbricks' No-Code Actions. Easily set up triggers based on Page URL, innerText, and CSS Selectors without touching a line of code. Inccrease user engagement and get insights at precise moments in the user journey.",
};
#### Actions

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "What are actions and why are they useful?",
title: "Using Actions in Formbricks | Fine-tuning User Moments",
description:
"Actions in Formbricks enable targeted survey displays during specific user journey moments. Enhance user segmentation by tracking actions for granular surveying.",
"Dive deep into how actions in Formbricks help products and teams to engage users at precise moments in their journey. Discover the power of actions, from coding to no-code setups, to refine user targeting and generate richer, more detailed user insights.",
};
#### Actions

View File

@@ -1,17 +1,21 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Responses API",
title: "Formbricks Public Client API Guide: Manage Survey Displays & Responses",
description:
"Explore the Formbricks Public Client API for client-side tasks and integration into your website.",
"Dive deep into Formbricks' Public Client API designed for customisation. This comprehensive guide provides detailed instructions on how to mark surveys as displayed as well as responded for individual persons, ensuring seamless client-side interactions without compromising data security.",
};
#### Management API
#### Client API
# Displays API
The Public Client API is designed for the JavaScript SDK and does not require authentication. It's primarily used for creating persons, sessions, and responses within the Formbricks platform. This API is ideal for client-side interactions, as it doesn't expose sensitive information.
This set of API can be used to
- [Mark Survey as Displayed](#mark-survey-as-displayed-for-person)
- [Mark Survey as Responded](#mark-survey-as-responded-for-person)
---
## Mark Survey as Displayed for Person {{ tag: 'POST', label: '/api/v1/client/diplays' }}

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "API Overview",
title: "Formbricks API Overview: Public Client & Management API Breakdown",
description:
"Explore Formbricks' APIs: Public Client API for client-side tasks, and Management API for account management with secure API Key authentication.",
"Get a detailed understanding of Formbricks' dual API offerings: the unauthenticated Public Client API optimized for client-side tasks and the secured Management API for advanced account operations. Choose the perfect fit for your integration needs and ensure robust data handling",
};
#### API
@@ -10,10 +10,15 @@ export const meta = {
Formbricks offers two types of APIs: the **Public Client API** and the **Management API**. Each API serves a different purpose, has different authentication requirements, and provides access to different data and settings.
Checkout the [API Key Setup](/docs/api/api-key-setup) - to generate, store, or delete API Keys.
## Public Client API
The Public Client API is designed for the JavaScript SDK and does not require authentication. It's primarily used for creating persons, sessions, and responses within the Formbricks platform. This API is ideal for client-side interactions, as it doesn't expose sensitive information.
- [Displays API](/docs/api/client/displays) - Mark Survey as Displayed or Responded for a Person
- [Responses API](/docs/api/client/responses) - Create & update responses for a survey
## Management API
The Management API provides access to all data and settings that are visible in the Formbricks App. This API requires a personal API Key for authentication, which can be generated in the Settings section of the Formbricks App. With the Management API, you can manage your Formbricks account programmatically, accessing and modifying data and settings as needed.
@@ -24,6 +29,14 @@ API requests made to the Management API are authorized using a personal API key.
To generate, store, or delete an API key, follow the instructions provided on the following page [API Key](/docs/api/api-key-setup).
- [Action Class API](/docs/api/management/action-classes) - Create, Update, and Delete Action Classes
- [Attribute Class API](/docs/api/management/attribute-classes) - Create, Update, and Delete Attribute Classes
- [Me API](/docs/api/management/me) - Retrieve Account Information
- [People API](/docs/api/management/people) - Create, Update, and Delete People
- [Responses API](/docs/api/management/responses) - Create, Update, and Delete Responses
- [Surveys API](/docs/api/management/surveys) - Create, Update, and Delete Surveys
- [Webhook API](/docs/api/management/webhooks) - Create, Update, and Delete Webhooks
<Note>
By understanding the differences between these two APIs, you can choose the appropriate one for your needs,
ensuring a secure and efficient integration with the Formbricks platform.

View File

@@ -1,9 +1,9 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Responses API",
title: "Formbricks Responses API Documentation - Manage Your Survey Data Seamlessly",
description:
"Explore the Formbricks Public Client API for client-side tasks and integration into your website.",
"Unlock the full potential of Formbricks' Responses API. From fetching to updating survey responses, our comprehensive guide helps you integrate and manage survey data efficiently without compromising security. Ideal for client-side interactions.",
};
#### Management API
@@ -14,104 +14,6 @@ The Public Client API is designed for the JavaScript SDK and does not require au
---
## List all responses {{ tag: 'GET', label: '/api/v1/responses' }}
<Row>
<Col>
Retrieve all the responses you have received for all your surveys.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
### Optional Query Params
<Properties>
<Property name="surveyId" type="string">
SurveyId to filter responses by.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/responses">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/responses' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data":[
{
"id":"cllnfybxd051rpl0gieavthr9",
"createdAt":"2023-08-23T07:56:33.121Z",
"updatedAt":"2023-08-23T07:56:41.793Z",
"surveyId":"cllnfy2780fromy0hy7uoxvtn",
"finished":true,
"data":{
"ec7agikkr58j8uonhioinkyk":"Loved it!",
"gml6mgy71efgtq8np3s9je5p":"clicked",
"klvpwd4x08x8quesihvw5l92":"Product Manager",
"kp62fbqe8cfzmvy8qwpr81b2":"Very disappointed",
"lkjaxb73ulydzeumhd51sx9g":"Not interesed.",
"ryo75306flyg72iaeditbv51":"Would love if it had dark theme."
},
"meta":{
"url":"https://app.formbricks.com/s/cllnfy2780fromy0hy7uoxvtn",
"userAgent":{
"os":"Linux",
"browser":"Chrome"
}
},
"personAttributes":null,
"person":null,
"notes":[],
"tags":[]
}
]
}
```
```json {{ title: '404 Not Found' }}
{
"code": "not_found",
"message": "cllnfy2780fromy0hy7uoxvt not found",
"details": {
"resource_id": "survey",
"resource_type": "cllnfy2780fromy0hy7uoxvt"
}
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Create a response {{ tag: 'POST', label: '/api/v1/client/responses' }}
Add a new response to a survey.
@@ -222,7 +124,7 @@ Add a new response to a survey.
---
## Update a response {{ tag: 'POST', label: '/api/v1/client/responses/[responseId]' }}
## Update a response {{ tag: 'POST', label: '/api/v1/client/responses/<response-id>' }}
Update an existing response in a survey.
@@ -247,10 +149,10 @@ Update an existing response in a survey.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/v1/client/responses/[responseId]">
<CodeGroup title="Request" tag="POST" label="/api/v1/client/responses/<response-id>">
```bash {{ title: 'cURL' }}
curl --location --request POST 'https://app.formbricks.com/api/v1/client/responses/[responseId]' \
curl --location --request POST 'https://app.formbricks.com/api/v1/client/responses/<response-id>' \
--data-raw '{
"personId": "clfqjny0v000ayzgsycx54a2c",
"surveyId": "clfqz1esd0000yzah51trddn8",

View File

@@ -0,0 +1,301 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks People API: Fetch or Create Person Overview",
description:
"Dive into Formbricks' People API within the Public Client API suite, designed to work without authentication requirements. Seamlessly fetch or create a person by their userId and environmentId, optimizing client-side interactions while maintaining data privacy.",
};
#### Management API
# Action Classes API
This set of API can be used to
- [List Actions](#get-all-action-classes)
- [Get Action](#get-action-class-by-id)
- [Create Actions](#create-action-class)
- [Delete Actions](#delete-action-class)
<Note>You will need an API Key to interact with these APIs.</Note>
---
## Get all Action Classes {{ tag: 'GET', label: '/api/v1/management/action-classes' }}
<Row>
<Col>
Get all the existing action classes in your environment.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/action-classes">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/action-classes' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": [
{
"id": "cln8k0t47000gz87nw4ibwv35",
"createdAt": "2023-10-02T07:13:19.207Z",
"updatedAt": "2023-10-02T07:13:19.207Z",
"name": "New Session",
"description": "Gets fired when a new session is created",
"type": "automatic",
"noCodeConfig": null,
"environmentId": "cln8k0t47000fz87njmmu2bck"
},
{
"id": "cln8k0t55000uz87noerwdooj",
"createdAt": "2023-10-02T07:13:19.241Z",
"updatedAt": "2023-10-02T07:13:19.241Z",
"name": "Invited Team Member",
"description": "Person invited a team member",
"type": "noCode",
"noCodeConfig": {
"type": "innerHtml",
"innerHtml": {
"value": "Add Team Member"
}
},
"environmentId": "cln8k0t47000fz87njmmu2bck"
},
]
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Action Class by ID {{ tag: 'GET', label: '/api/v1/management/action-classes/<action-class-id>' }}
<Row>
<Col>
Fetch an action class by its ID.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/action-classes/<action-class-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/action-classes/<action-class-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln8k0t55000uz87noerwdooj",
"createdAt": "2023-10-02T07:13:19.241Z",
"updatedAt": "2023-10-02T07:13:19.241Z",
"name": "Invited Team Member",
"description": "Person invited a team member",
"type": "noCode",
"noCodeConfig": {
"type": "innerHtml",
"innerHtml": {
"value": "Add Team Member"
}
},
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Create Action Class {{ tag: 'POST', label: '/api/v1/management/action-classes/' }}
<Row>
<Col>
Create an action class.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
### Body
<CodeGroup title="Request Body">
```json {{ title: 'cURL' }}
{
"environmentId": "cln8k0t47000fz87njmmu2bck",
"name": "My Action from API",
"type": "code"
}
```
</CodeGroup>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/v1/management/action-classes/">
```bash {{ title: 'cURL' }}
curl -X POST https://app.formbricks.com/api/v1/management/action-classes/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-api-key>' \
-d '{"environmentId": "cln8k0t47000fz87njmmu2bck", "name": "My Action from API", "type": "code"}'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln9w1cno0008z8zu79nk5w0c",
"createdAt": "2023-10-03T05:37:26.100Z",
"updatedAt": "2023-10-03T05:37:26.100Z",
"name": "My Action from API",
"description": null,
"type": "code",
"noCodeConfig": null,
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete Action Class {{ tag: 'DELETE', label: '/api/v1/management/action-classes/<action-class-id>' }}
<Row>
<Col>
Delete an action class by its ID.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/management/action-classes/<action-class-id>">
```bash {{ title: 'cURL' }}
curl -X DELETE https://app.formbricks.com/api/v1/management/action-classes/<action-class-id> \
--header 'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln9w1cno0008z8zu79nk5w0c",
"createdAt": "2023-10-03T05:37:26.100Z",
"updatedAt": "2023-10-03T05:37:26.100Z",
"name": "My Action from API",
"description": null,
"type": "code",
"noCodeConfig": null,
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

@@ -4,9 +4,9 @@ import AddApiKey from "./add-api-key.webp";
import ApiKeySecret from "./api-key-secret.webp";
export const meta = {
title: "API Key Setup",
title: "Formbricks API Key: Setup and Testing",
description:
"Generate, store, and delete personal API keys for secure Formbricks access. Ensure safekeeping to prevent unauthorized account control.",
"This guide provides step-by-step instructions to generate, store, and delete API keys, ensuring safe and authenticated access to your Formbricks account.",
};
#### API

View File

@@ -0,0 +1,292 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks People API: Fetch or Create Person Overview",
description:
"Dive into Formbricks' People API within the Public Client API suite, designed to work without authentication requirements. Seamlessly fetch or create a person by their userId and environmentId, optimizing client-side interAttributes while maintaining data privacy.",
};
#### Management API
# Attribute Classes API
This set of API can be used to
- [List Attributes](#get-all-attribute-classes)
- [Get Attributes](#get-attribute-class-by-id)
- [Create Attributes](#create-attribute-class)
- [Delete Attributes](#delete-attribute-class)
<Note>You will need an API Key to interact with these APIs.</Note>
---
## Get all Attribute Classes {{ tag: 'GET', label: '/api/v1/management/attribute-classes' }}
<Row>
<Col>
Get all the existing attribute classes in your environment.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/attribute-classes">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/attribute-classes' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": [
{
"id": "cln8k0t47000kz87n3lh23zf0",
"createdAt": "2023-10-02T07:13:19.207Z",
"updatedAt": "2023-10-02T07:13:19.207Z",
"name": "email",
"description": "The email of the person",
"archived": false,
"type": "automatic",
"environmentId": "cln8k0t47000fz87njmmu2bck"
},
{
"id": "cln8k0t55000xz87nrtwbo7sf",
"createdAt": "2023-10-02T07:13:19.241Z",
"updatedAt": "2023-10-02T07:13:19.241Z",
"name": "Name",
"description": "Full Name of the Person",
"archived": false,
"type": "code",
"environmentId": "cln8k0t47000fz87njmmu2bck"
},
]
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Attribute Class by ID {{ tag: 'GET', label: '/api/v1/management/attribute-classes/<attribute-class-id>' }}
<Row>
<Col>
Fetch an Attribute class by its ID.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/attribute-classes/<attribute-class-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/attribute-classes/<attribute-class-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln8k0t47000jz87nfwcey6mh",
"createdAt": "2023-10-02T07:13:19.207Z",
"updatedAt": "2023-10-02T07:13:19.207Z",
"name": "userId",
"description": "The internal ID of the person",
"archived": false,
"type": "automatic",
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Create Attribute Class {{ tag: 'POST', label: '/api/v1/management/attribute-classes/' }}
<Row>
<Col>
Create an Attribute class.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
### Body
<CodeGroup title="Request Body">
```json {{ title: 'cURL' }}
{
"environmentId": "clmlmwdqq0003196ufewo6ibg",
"name": "My Attribute from API",
"type": "code",
"description": "My description"
}
```
</CodeGroup>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/v1/management/attribute-classes/">
```bash {{ title: 'cURL' }}
curl -X POST https://app.formbricks.com/api/v1/management/attribute-classes/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-api-key>' \
-d '{"environmentId": "clmlmwdqq0003196ufewo6ibg", "name": "My Attribute from API", "type": "code", "description":"My description"}'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "clna0hd7z0009z8zue2z3a7wy",
"createdAt": "2023-10-03T07:41:51.792Z",
"updatedAt": "2023-10-03T07:41:51.792Z",
"name": "My Attribute from API",
"description": null,
"archived": false,
"type": "code",
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete Attribute Class {{ tag: 'DELETE', label: '/api/v1/management/attribute-classes/<attribute-class-id>' }}
<Row>
<Col>
Delete an Attribute class by its ID.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/management/attribute-classes/<attribute-class-id>">
```bash {{ title: 'cURL' }}
curl -X DELETE https://app.formbricks.com/api/v1/management/attribute-classes/<attribute-class-id> \
--header 'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "clna0hd7z0009z8zue2z3a7wy",
"createdAt": "2023-10-03T07:41:51.792Z",
"updatedAt": "2023-10-03T07:41:51.792Z",
"name": "My Attribute from API",
"description": null,
"archived": false,
"type": "code",
"environmentId": "cln8k0t47000fz87njmmu2bck"
}
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -0,0 +1,78 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks People API: Fetch or Create Person Overview",
description:
"Dive into Formbricks' People API within the Public Client API suite, designed to work without authentication requirements. Seamlessly fetch or create a person by their userId and environmentId, optimizing client-side interactions while maintaining data privacy.",
};
#### Management API
# Me API
This API can be used to get your own current environment details.
<Note>You will need an API Key to interact with these APIs.</Note>
---
## Get Environment {{ tag: 'GET', label: '/api/v1/management/me' }}
<Row>
<Col>
Get your current environment details.
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/me">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/me' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"id": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.207Z",
"updatedAt": "2023-10-02T07:14:14.162Z",
"type": "production",
"product": {
"id": "cln8k0t47000ez87n57aqywvz",
"name": "Demo Product"
},
"widgetSetupCompleted": true
}
```
```json {{ title: '401 Unauthorized' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -0,0 +1,234 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks People API: Fetch or Create Person Overview",
description:
"Dive into Formbricks' People API within the Public Client API suite, designed to work without authentication requirements. Seamlessly fetch or create a person by their userId and environmentId, optimizing client-side interactions while maintaining data privacy.",
};
#### Management API
# People API
This set of API can be used to
- [List People](#list-people)
- [Get Person](#get-person)
- [Delete Person](#delete-person)
<Note>You will need an API Key to interact with these APIs.</Note>
---
## List People {{ tag: 'GET', label: '/api/v1/management/people' }}
<Row>
<Col>
List People
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/people">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/people' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": [
{
"id": "b4wgrzl363dn3zb6yy5gf265",
"attributes": {
"userId": "CYO618",
"email": "sophia@amazon.com",
"Name": "Sophia Johnson",
"Role": "Designer",
"Company": "Amazon",
"Experience": "7 years",
"Usage Frequency": "Yearly",
"Company Size": "1628 employees",
"Product Satisfaction Score": "62",
"Recommendation Likelihood": "9"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
},
{
"id": "jrb5iyzqvnkg9322ckhde3j4",
"attributes": {
"userId": "CYO511",
"email": "antonio@ibm.com",
"Name": "Antonio García",
"Role": "Designer",
"Company": "IBM",
"Experience": "1 years",
"Usage Frequency": "Weekly",
"Company Size": "4023 employees",
"Product Satisfaction Score": "77",
"Recommendation Likelihood": "4"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
},
]
}
```
```json {{ title: '400 Bad Request' }}
{
"code": "bad_request",
"message": "Fields are missing or incorrectly formatted",
"details": {
"userId": ""
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Person {{ tag: 'GET', label: '/api/v1/management/people/<person-id>' }}
<Row>
<Col>
Get Person by ID
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/people/<person-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/people/<person-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "jrb5iyzqvnkg9322ckhde3j4",
"attributes": {
"userId": "CYO511",
"email": "antonio@ibm.com",
"Name": "Antonio García",
"Role": "Designer",
"Company": "IBM",
"Experience": "1 years",
"Usage Frequency": "Weekly",
"Company Size": "4023 employees",
"Product Satisfaction Score": "77",
"Recommendation Likelihood": "4"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
}
}
```
```json {{ title: '404 Not Found' }}
{
"code": "not_found",
"message": "Person not found",
"details": {
"resource_id": "clmlmykc2000019vz5o3jglsa",
"resource_type": "Person"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete Person {{ tag: 'DELETE', label: '/api/v1/management/people/<person-id>' }}
<Row>
<Col>
Delete Person by ID
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/management/people/<person-id>">
```bash {{ title: 'cURL' }}
curl -X DELETE https://app.formbricks.com/api/v1/management/people/<person-id> \
--header 'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"success": "Person deleted successfully"
}
}
```
```json {{ title: '404 Not Found' }}
{
"code": "not_found",
"message": "Person not found",
"details": {
"resource_id": "clmlmykc2000019vz5o3jglsa",
"resource_type": "Person"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -0,0 +1,289 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks Responses API Documentation - Manage Your Survey Data Seamlessly",
description:
"Unlock the full potential of Formbricks' Responses API. From fetching to updating survey responses, our comprehensive guide helps you integrate and manage survey data efficiently without compromising security. Ideal for client-side interactions.",
};
#### Management API
# Responses API
This set of API can be used to
- [List Responses](#list-all-responses)
- [Get Response](#get-response-by-id)
- [Delete Response](#delete-a-response)
<Note>You will need an API Key to interact with these APIs.</Note>
---
## List all Responses {{ tag: 'GET', label: '/api/v1/management/responses' }}
<Row>
<Col>
Retrieve all the responses you have received in your environment.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/responses">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/responses' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data":[
{
"id": "cln8k0tqv00pcz87no4qrw333",
"createdAt": "2023-10-02T07:13:20.023Z",
"updatedAt": "2023-10-02T07:13:20.023Z",
"surveyId": "cln8k0tqu00p7z87nqr4thi3k",
"finished": true,
"data": {
"interview-prompt": "clicked"
},
"meta": {
"userAgent": {
"os": "MacOS",
"browser": "Chrome"
}
},
"personAttributes": null,
"person": {
"id": "e0x4i5tvsp8puxfztyrwykvn",
"attributes": {
"userId": "CYO675",
"email": "ravi@netflix.com",
"Name": "Ravi Kumar",
"Role": "Manager",
"Company": "Netflix",
"Experience": "6 years",
"Usage Frequency": "Monthly",
"Company Size": "4610 employees",
"Product Satisfaction Score": "43",
"Recommendation Likelihood": "4"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
},
"notes": [],
"tags": []
},
]
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Response by ID {{ tag: 'GET', label: '/api/v1/management/responses/<response-id>' }}
<Row>
<Col>
Retrieve a response by its ID.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/responses/<response-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/responses/<response-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data":
{
"id": "cln8k0tqv00pbz87nwo5lr72b",
"createdAt": "2023-10-02T07:13:20.023Z",
"updatedAt": "2023-10-02T07:13:20.023Z",
"surveyId": "cln8k0tqu00p7z87nqr4thi3k",
"finished": true,
"data": {
"interview-prompt": "clicked"
},
"meta": {
"userAgent": {
"os": "Windows",
"browser": "Edge"
}
},
"personAttributes": null,
"person": {
"id": "hsx38f15v50ua8383uadagq5",
"attributes": {
"userId": "CYO278",
"email": "jorge@facebook.com",
"Name": "Jorge Sanchez",
"Role": "Product Manager",
"Company": "Facebook",
"Experience": "10 years",
"Usage Frequency": "Daily",
"Company Size": "1685 employees",
"Product Satisfaction Score": "84",
"Recommendation Likelihood": "6"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
},
"notes": [],
"tags": []
}
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete a response {{ tag: 'DELETE', label: '/api/v1/client/responses/<response-id>' }}
<Row>
<Col>
Delete Response by ID
### Mandatory Headers
<Properties>
<Property name="x-api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/client/responses/<response-id>">
```bash {{ title: 'cURL' }}
curl -X DELETE https://app.formbricks.com/api/v1/management/resposnes/<response-id> \
--header 'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: '200 Success' }}
{
"data": {
"id": "cln8k0tqv00pbz87nwo5lr72b",
"createdAt": "2023-10-02T07:13:20.023Z",
"updatedAt": "2023-10-02T07:13:20.023Z",
"surveyId": "cln8k0tqu00p7z87nqr4thi3k",
"finished": true,
"data": {
"interview-prompt": "clicked"
},
"meta": {
"userAgent": {
"os": "Windows",
"browser": "Edge"
}
},
"personAttributes": null,
"person": {
"id": "hsx38f15v50ua8383uadagq5",
"attributes": {
"userId": "CYO278",
"email": "jorge@facebook.com",
"Name": "Jorge Sanchez",
"Role": "Product Manager",
"Company": "Facebook",
"Experience": "10 years",
"Usage Frequency": "Daily",
"Company Size": "1685 employees",
"Product Satisfaction Score": "84",
"Recommendation Likelihood": "6"
},
"environmentId": "cln8k0t47000fz87njmmu2bck",
"createdAt": "2023-10-02T07:13:19.444Z",
"updatedAt": "2023-10-02T07:13:19.444Z"
},
"notes": [],
"tags": []
}
}
```
```json {{ title: '400 Bad Request' }}
{
"code": "bad_request",
"message": "surveyId was not provided.",
"details": {
"surveyId": "This field is required."
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -0,0 +1,667 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Formbricks Surveys API Documentation - How to Retrieve All Surveys",
description:
"Explore the comprehensive guide to the Formbricks Surveys API. Learn how to effectively retrieve all the surveys in your environment with the necessary headers and API key setup. Includes sample request and response formats.",
};
#### Management API
# Surveys API
This set of API can be used to
- [List All Surveys](#list-all-surveys)
- [Get Survey](#get-survey-by-id)
- [Create Survey](#create-survey)
- [Delete Survey](#delete-survey-by-id)
<Note>You will need an API Key to interact with these APIs.</Note>
---
## List all surveys {{ tag: 'GET', label: '/api/v1/management/surveys' }}
<Row>
<Col>
Retrieve all the surveys you have for the environment.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/surveys">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/surveys' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": [
{
"id": "cllnfy2780fromy0hy7uoxvtn",
"createdAt": "2023-08-23T07:56:20.516Z",
"updatedAt": "2023-08-23T07:56:26.947Z",
"name": "Product Market Fit (Superhuman)",
"type": "link",
"environmentId": "cll2m30r70004mx0huqkitgqv",
"status": "inProgress",
"attributeFilters": [],
"displayOption": "displayOnce",
"autoClose": null,
"triggers": [],
"redirectUrl": null,
"recontactDays": null,
"questions": [
{
"id": "gml6mgy71efgtq8np3s9je5p",
"type": "cta",
"headline": "You are one of our power users! Do you have 5 minutes?",
"required": false,
"buttonLabel": "Happy to help!",
"logic": [
{
"condition": "skipped",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We would love to understand your user experience better. Sharing your insight helps a lot!</span></p>",
"buttonExternal": false,
"dismissButtonLabel": "No, thanks."
},
{
"id": "kp62fbqe8cfzmvy8qwpr81b2",
"type": "multipleChoiceSingle",
"headline": "How disappointed would you be if you could no longer use My Product?",
"subheader": "Please select one of the following options:",
"required": true,
"choices": [
{
"id": "bdgy1hnwd7uwmfxk1ljqp1n5",
"label": "Not at all disappointed"
},
{
"id": "poabnvgtwenp8rb2v70gj4hj",
"label": "Somewhat disappointed"
},
{
"id": "opfiqyqz8wrqn0i0f7t24d3n",
"label": "Very disappointed"
}
],
"shuffleOption": "none"
},
{
"id": "klvpwd4x08x8quesihvw5l92",
"type": "multipleChoiceSingle",
"headline": "What is your role?",
"subheader": "Please select one of the following options:",
"required": true,
"choices": [
{
"id": "c8nerw6l9gpsxcmqkn10f9hy",
"label": "Founder"
},
{
"id": "ebjqezei6a2axtuq86cleetn",
"label": "Executive"
},
{
"id": "ctiijjblyhlp22snypfamqt1",
"label": "Product Manager"
},
{
"id": "ibalyr0mhemfkkr82vypmg40",
"label": "Product Owner"
},
{
"id": "fipk606aegslbd0e7yhc0xjx",
"label": "Software Engineer"
}
],
"shuffleOption": "none"
},
{
"id": "ryo75306flyg72iaeditbv51",
"type": "openText",
"headline": "What type of people do you think would most benefit from My Product?",
"required": true
},
{
"id": "lkjaxb73ulydzeumhd51sx9g",
"type": "openText",
"headline": "What is the main benefit your receive from My Product?",
"required": true
},
{
"id": "ec7agikkr58j8uonhioinkyk",
"type": "openText",
"headline": "How can we improve My Product for you?",
"subheader": "Please be as specific as possible.",
"required": true
}
],
"thankYouCard": {
"enabled": true,
"headline": "Thank you!",
"subheader": "We appreciate your feedback."
},
"delay": 0,
"autoComplete": null,
"closeOnDate": null
}
]
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Survey by ID {{ tag: 'GET', label: '/api/v1/management/surveys/<survey-id>' }}
<Row>
<Col>
Get a specific survey by its ID.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/management/surveys/<survey-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/management/surveys/<survey-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln8k0tjz00n5z87nwq527h3z",
"createdAt": "2023-10-02T07:13:19.775Z",
"updatedAt": "2023-10-02T07:13:19.775Z",
"name": "Churn Survey",
"type": "link",
"environmentId": "cln8k0t47000fz87njmmu2bck",
"status": "inProgress",
"attributeFilters": [],
"displayOption": "displayOnce",
"autoClose": null,
"triggers": [],
"redirectUrl": null,
"recontactDays": null,
"questions": [
{
"id": "churn-reason",
"type": "multipleChoiceSingle",
"headline": "Why did you cancel your subscription?",
"subheader": "We're sorry to see you leave. Help us do better:",
"required": true,
"logic": [
{
"condition": "equals",
"value": "Difficult to use",
"destination": "easier-to-use"
},
{
"condition": "equals",
"value": "It's too expensive",
"destination": "30-off"
},
{
"condition": "equals",
"value": "I am missing features",
"destination": "missing-features"
},
{
"condition": "equals",
"value": "Poor customer service",
"destination": "poor-service"
},
{
"condition": "equals",
"value": "I just didn't need it anymore",
"destination": "end"
}
],
"choices": [
{
"id": "isud2xethsw63dlwl89kr4kj",
"label": "Difficult to use"
},
{
"id": "opuu4ba3dlele3n0gjkuh27c",
"label": "It's too expensive"
},
{
"id": "gnypapo0rhvkt8pwosrphvbl",
"label": "I am missing features"
},
{
"id": "wkgsrsrazd9kfunqhzjezx6t",
"label": "Poor customer service"
},
{
"id": "pykmgyyw74vg0gaeryj6bo4c",
"label": "I just didn't need it anymore"
}
]
},
{
"id": "easier-to-use",
"type": "openText",
"headline": "What would have made {{productName}} easier to use?",
"subheader": "",
"required": true,
"buttonLabel": "Send",
"logic": [
{
"condition": "submitted",
"destination": "end"
}
]
},
{
"id": "30-off",
"type": "cta",
"headline": "Get 30% off for the next year!",
"required": true,
"buttonLabel": "Get 30% off",
"logic": [
{
"condition": "clicked",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We'd love to keep you as a customer. Happy to offer a 30% discount for the next year.</span></p>",
"buttonUrl": "https://formbricks.com",
"buttonExternal": true,
"dismissButtonLabel": "Skip"
},
{
"id": "missing-features",
"type": "openText",
"headline": "What features are you missing?",
"subheader": "",
"required": true,
"logic": [
{
"condition": "submitted",
"destination": "end"
}
]
},
{
"id": "poor-service",
"type": "cta",
"headline": "So sorry to hear 😔 Talk to our CEO directly!",
"required": true,
"buttonLabel": "Send email to CEO",
"logic": [
{
"condition": "clicked",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We aim to provide the best possible customer service. Please email our CEO and she will personally handle your issue.</span></p>",
"buttonUrl": "mailto:ceo@company.com",
"buttonExternal": true,
"dismissButtonLabel": "Skip"
}
],
"thankYouCard": {
"enabled": false
},
"delay": 0,
"autoComplete": null,
"closeOnDate": null,
"surveyClosedMessage": null,
"verifyEmail": null
}
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Create Survey {{ tag: 'POST', label: '/api/v1/management/surveys' }}
<Row>
<Col>
Create a survey
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
### Body
<CodeGroup title="Request Body">
```json {{ title: 'cURL' }}
{
"environmentId": "clmlmwdqq0003196ufewo6ibg",
"type": "link",
"name": "My new Survey"
}
```
</CodeGroup>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/v1/management/surveys">
```bash {{ title: 'cURL' }}
curl -X DELETE \
'https://app.formbricks.com/api/v1/management/surveys' \
--header \
'x-api-key: <your-api-key>'
```
```bash {{ title: 'cURL' }}
curl -X POST https://app.formbricks.com/api/v1/management/surveys/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <your-api-key>' \
-d '{"environmentId": "cln8k0t47000fz87njmmu2bck", "name": "My Survey from API", "type": "link"}'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "clna6bqnz000az8zubq3e757t",
"createdAt": "2023-10-03T10:25:26.975Z",
"updatedAt": "2023-10-03T10:25:26.975Z",
"name": "My new Survey",
"redirectUrl": null,
"type": "link",
"environmentId": "cln8k0t47000fz87njmmu2bck",
"status": "draft",
"questions": [],
"thankYouCard": {
"enabled": false
},
"displayOption": "displayOnce",
"recontactDays": null,
"autoClose": null,
"delay": 0,
"autoComplete": null,
"closeOnDate": null,
"surveyClosedMessage": null,
"verifyEmail": null
}
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete Survey by ID {{ tag: 'DELETE', label: '/api/v1/management/surveys/<survey-id>' }}
<Row>
<Col>
Delete a survey by its ID.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/management/surveys/<survey-id>">
```bash {{ title: 'cURL' }}
curl -X DELETE \
'https://app.formbricks.com/api/v1/management/surveys/<survey-id>' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"id": "cln8k0tjz00n5z87nwq527h3z",
"createdAt": "2023-10-02T07:13:19.775Z",
"updatedAt": "2023-10-02T07:13:19.775Z",
"name": "Churn Survey",
"type": "link",
"environmentId": "cln8k0t47000fz87njmmu2bck",
"status": "inProgress",
"attributeFilters": [],
"displayOption": "displayOnce",
"autoClose": null,
"triggers": [],
"redirectUrl": null,
"recontactDays": null,
"questions": [
{
"id": "churn-reason",
"type": "multipleChoiceSingle",
"headline": "Why did you cancel your subscription?",
"subheader": "We're sorry to see you leave. Help us do better:",
"required": true,
"logic": [
{
"condition": "equals",
"value": "Difficult to use",
"destination": "easier-to-use"
},
{
"condition": "equals",
"value": "It's too expensive",
"destination": "30-off"
},
{
"condition": "equals",
"value": "I am missing features",
"destination": "missing-features"
},
{
"condition": "equals",
"value": "Poor customer service",
"destination": "poor-service"
},
{
"condition": "equals",
"value": "I just didn't need it anymore",
"destination": "end"
}
],
"choices": [
{
"id": "isud2xethsw63dlwl89kr4kj",
"label": "Difficult to use"
},
{
"id": "opuu4ba3dlele3n0gjkuh27c",
"label": "It's too expensive"
},
{
"id": "gnypapo0rhvkt8pwosrphvbl",
"label": "I am missing features"
},
{
"id": "wkgsrsrazd9kfunqhzjezx6t",
"label": "Poor customer service"
},
{
"id": "pykmgyyw74vg0gaeryj6bo4c",
"label": "I just didn't need it anymore"
}
]
},
{
"id": "easier-to-use",
"type": "openText",
"headline": "What would have made {{productName}} easier to use?",
"subheader": "",
"required": true,
"buttonLabel": "Send",
"logic": [
{
"condition": "submitted",
"destination": "end"
}
]
},
{
"id": "30-off",
"type": "cta",
"headline": "Get 30% off for the next year!",
"required": true,
"buttonLabel": "Get 30% off",
"logic": [
{
"condition": "clicked",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We'd love to keep you as a customer. Happy to offer a 30% discount for the next year.</span></p>",
"buttonUrl": "https://formbricks.com",
"buttonExternal": true,
"dismissButtonLabel": "Skip"
},
{
"id": "missing-features",
"type": "openText",
"headline": "What features are you missing?",
"subheader": "",
"required": true,
"logic": [
{
"condition": "submitted",
"destination": "end"
}
]
},
{
"id": "poor-service",
"type": "cta",
"headline": "So sorry to hear 😔 Talk to our CEO directly!",
"required": true,
"buttonLabel": "Send email to CEO",
"logic": [
{
"condition": "clicked",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We aim to provide the best possible customer service. Please email our CEO and she will personally handle your issue.</span></p>",
"buttonUrl": "mailto:ceo@company.com",
"buttonExternal": true,
"dismissButtonLabel": "Skip"
}
],
"thankYouCard": {
"enabled": false
},
"delay": 0,
"autoComplete": null,
"closeOnDate": null,
"surveyClosedMessage": null,
"verifyEmail": null
}
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -1,30 +1,31 @@
export const meta = {
title: "Webhook API Overview",
description: "Learn how to use the Formbricks Webhook API.",
title: "Formbricks Webhook API Documentation - List, Retrieve, Create, and Delete Webhooks",
description:
"Explore the comprehensive guide to the Formbricks Webhooks API. This is all you need to interact and play with the Formbricks Webhooks and integrate them into any third party app of your choice",
};
#### Webhook API
#### Management API
# Webhook API
Formbricks' Webhook API offers a powerful interface for interacting with webhooks. Webhooks in Formbricks allow you to receive real-time HTTP notifications of changes to specific objects in the Formbricks environment.
Before you start managing webhooks, you need to create an API key. This will be used for authorization when making requests to the Webhook API. Please see the [API key setup page](/docs/api/api-key-setup) for more details on how to create and manage your API keys.
Formbricks' Webhook API offers a powerful interface for interacting with webhooks. Webhooks allow you to receive real-time HTTP notifications of changes to specific objects in the Formbricks environment.
The behavior of the webhooks is determined by their trigger settings. The trigger determines which updates the webhook sends. Current available triggers include "responseCreated", "responseUpdated", and "responseFinished". This allows you to customize your webhooks to only send notifications for the events that are relevant to your application.
Webhooks are tied to a specific Formbricks environment. Once set, a webhook will receive updates from all surveys within this environment. This makes it easy to manage your data flow and ensure that all relevant updates are caught by the webhook.
Our API has several REST endpoints enabling you to manage these webhooks, providing a great deal of flexibility:
This set of API can be used to
- [List All Webhooks](#list-webhooks)
- [Get Webhook](#retrieve-webhook-by-id)
- [Create Webhook](#create-webhook)
- [Delete Webhook](#delete-webhook-by-id)
1. **List Webhooks:** Retrieve a list of all existing webhooks.
1. **Retrieve Webhook by ID:** Retrieve a specific webhook by it's ID.
1. **Create a New Webhook:** Add a new webhook to your system.
1. **Get a Specific Webhook:** Query the details of a specific webhook using its unique ID.
1. **Delete a Webhook:** Remove an existing webhook.
And the detailed Webhook Paylod is elaborated [here](#webhook-payload).
These APIs are designed to facilitate seamless integration of Formbricks with third-party systems. By making use of our webhook API, you can automate the process of sending data to these systems whenever significant events occur within your Formbricks environment.
<Note>You will need an API Key to interact with these APIs.</Note>
---
## List Webhooks {{ tag: 'GET', label: '/api/v1/webhooks' }}
@@ -92,7 +93,7 @@ These APIs are designed to facilitate seamless integration of Formbricks with th
---
## Retrieve Webhook by ID {{ tag: 'GET', label: '/api/v1/webhooks/[webhookId]' }}
## Retrieve Webhook by ID {{ tag: 'GET', label: '/api/v1/webhooks/<webhook-id>' }}
<Row>
<Col>
@@ -108,11 +109,11 @@ These APIs are designed to facilitate seamless integration of Formbricks with th
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/webhooks/[webhookId]">
<CodeGroup title="Request" tag="GET" label="/api/v1/webhooks/<webhook-id>">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/webhooks/[webhookId]' \
'https://app.formbricks.com/api/v1/webhooks/<webhook-id>' \
--header \
'x-api-key: <your-api-key>'
```
@@ -255,7 +256,7 @@ Add a webhook to your product.
---
## Delete Webhook by ID {{ tag: 'DELETE', label: '/api/v1/webhooks/[webhookId]' }}
## Delete Webhook by ID {{ tag: 'DELETE', label: '/api/v1/webhooks/<webhook-id>' }}
<Row>
<Col>
@@ -271,10 +272,10 @@ Add a webhook to your product.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/v1/webhooks/[webhookId]">
<CodeGroup title="Request" tag="DELETE" label="/api/v1/webhooks/<webhook-id>">
```bash {{ title: 'cURL' }}
curl --location --request DELETE 'https://app.formbricks.com/api/v1/webhooks/[webhookId]' \
curl --location --request DELETE 'https://app.formbricks.com/api/v1/webhooks/<webhook-id>' \
--header 'x-api-key: <your-api-key>'
```

View File

@@ -1,76 +0,0 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Responses API",
description:
"Explore the Formbricks Public Client API for client-side tasks and integration into your website.",
};
#### Management API
# People API
The Public Client API is designed for the JavaScript SDK and does not require authentication. It's primarily used for creating persons, sessions, and responses within the Formbricks platform. This API is ideal for client-side interactions, as it doesn't expose sensitive information.
---
## Get or Create Person {{ tag: 'GET', label: '/api/v1/client/people/getOrCreate' }}
<Row>
<Col>
Fetch a Person or create (if they don't exist) by their userId and the environmentId.
### Mandatory Query Parameters
<Properties>
<Property name="userId" type="string">
User ID to fetch or create (if it does not exist)
</Property>
</Properties>
<Properties>
<Property name="enviornmentId" type="string">
Formbricks Environment ID
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/client/people/getOrCreate">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/client/people/getOrCreate?userId=<user-id>&environmentId=<env-id>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": {
"person": {
"id": "clm4bcxms02hspj0ht05k6q5c",
"environmentId": "cll2m30r70004mx0huqkitgqv"
}
}
}
```
```json {{ title: '400 Bad Request' }}
{
"code": "bad_request",
"message": "Fields are missing or incorrectly formatted",
"details": {
"userId": ""
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -1,180 +0,0 @@
import { Fence } from "@/components/shared/Fence";
export const meta = {
title: "Surveys API",
description:
"Explore the Formbricks Public Client API for client-side tasks and integration into your website.",
};
#### Management API
# Surveys API
The Survey API currently has one endpoint that allows you to get all the surveys you have in your Formbricks environment. You will need the [API Key](/docs/api/api-key-setup) to access the same!
---
## List all surveys {{ tag: 'GET', label: '/api/v1/surveys' }}
<Row>
<Col>
Retrieve all the surveys you have for the environment.
### Mandatory Headers
<Properties>
<Property name="x-Api-Key" type="string">
Your Formbricks API key.
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/v1/surveys">
```bash {{ title: 'cURL' }}
curl --location \
'https://app.formbricks.com/api/v1/surveys' \
--header \
'x-api-key: <your-api-key>'
```
</CodeGroup>
<CodeGroup title="Response">
```json {{title:'200 Success'}}
{
"data": [
{
"id": "cllnfy2780fromy0hy7uoxvtn",
"createdAt": "2023-08-23T07:56:20.516Z",
"updatedAt": "2023-08-23T07:56:26.947Z",
"name": "Product Market Fit (Superhuman)",
"type": "link",
"environmentId": "cll2m30r70004mx0huqkitgqv",
"status": "inProgress",
"attributeFilters": [],
"displayOption": "displayOnce",
"autoClose": null,
"triggers": [],
"redirectUrl": null,
"recontactDays": null,
"questions": [
{
"id": "gml6mgy71efgtq8np3s9je5p",
"type": "cta",
"headline": "You are one of our power users! Do you have 5 minutes?",
"required": false,
"buttonLabel": "Happy to help!",
"logic": [
{
"condition": "skipped",
"destination": "end"
}
],
"html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We would love to understand your user experience better. Sharing your insight helps a lot!</span></p>",
"buttonExternal": false,
"dismissButtonLabel": "No, thanks."
},
{
"id": "kp62fbqe8cfzmvy8qwpr81b2",
"type": "multipleChoiceSingle",
"headline": "How disappointed would you be if you could no longer use My Product?",
"subheader": "Please select one of the following options:",
"required": true,
"choices": [
{
"id": "bdgy1hnwd7uwmfxk1ljqp1n5",
"label": "Not at all disappointed"
},
{
"id": "poabnvgtwenp8rb2v70gj4hj",
"label": "Somewhat disappointed"
},
{
"id": "opfiqyqz8wrqn0i0f7t24d3n",
"label": "Very disappointed"
}
],
"shuffleOption": "none"
},
{
"id": "klvpwd4x08x8quesihvw5l92",
"type": "multipleChoiceSingle",
"headline": "What is your role?",
"subheader": "Please select one of the following options:",
"required": true,
"choices": [
{
"id": "c8nerw6l9gpsxcmqkn10f9hy",
"label": "Founder"
},
{
"id": "ebjqezei6a2axtuq86cleetn",
"label": "Executive"
},
{
"id": "ctiijjblyhlp22snypfamqt1",
"label": "Product Manager"
},
{
"id": "ibalyr0mhemfkkr82vypmg40",
"label": "Product Owner"
},
{
"id": "fipk606aegslbd0e7yhc0xjx",
"label": "Software Engineer"
}
],
"shuffleOption": "none"
},
{
"id": "ryo75306flyg72iaeditbv51",
"type": "openText",
"headline": "What type of people do you think would most benefit from My Product?",
"required": true
},
{
"id": "lkjaxb73ulydzeumhd51sx9g",
"type": "openText",
"headline": "What is the main benefit your receive from My Product?",
"required": true
},
{
"id": "ec7agikkr58j8uonhioinkyk",
"type": "openText",
"headline": "How can we improve My Product for you?",
"subheader": "Please be as specific as possible.",
"required": true
}
],
"thankYouCard": {
"enabled": true,
"headline": "Thank you!",
"subheader": "We appreciate your feedback."
},
"delay": 0,
"autoComplete": null,
"closeOnDate": null
}
]
}
```
```json {{ title: '401 Not Authenticated' }}
{
"code": "not_authenticated",
"message": "Not authenticated",
"details": {
"x-Api-Key": "Header not provided or API Key invalid"
}
}
```
</CodeGroup>
</Col>
</Row>
---

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Setting attributes with code",
title: "Guide for Setting Custom Attributes | Formbricks Documentation",
description:
"Set attributes in code using setAttribute function. Enhance user segmentation, target surveys effectively, and gather valuable insights for better decisions. All open-source.",
"Learn how to set attributes in code using setAttribute function. Enhance user segmentation, target surveys effectively, and gather valuable insights for better decisions. Easily send user-specific details for better survey segmentation and gain deeper insights.",
};
#### Attributes
@@ -13,7 +13,7 @@ One way to send attributes to Formbricks is in your code. In Formbricks, there a
## Setting Custom User Attributes
You can use the setAttribute function to set any custom attribute for the user (e.g. name, plan, etc.):
<Col>
<CodeGroup title="Setting Plan to Pro">
```javascript
@@ -21,9 +21,9 @@ formbricks.setAttribute("Plan", "Pro");
```
</CodeGroup>
</Col>
Generally speaking, the setAttribute function works like this:
<Col>
<CodeGroup title="Setting Custom Attributes">
```javascript
@@ -31,5 +31,5 @@ formbricks.setAttribute("attribute_key", "attribute_value");
```
</CodeGroup>
</Col>
Where `attributeName` is the name of the attribute you want to set, and `attributeValue` is the value of the attribute you want to set.

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Identifying Users",
title: "User Identification in Formbricks | Enhancing Survey Feedback",
description:
"Identify users with Formbricks by setting User ID, email, and custom attributes. Enhance survey targeting and recontacting while maintaining user privacy.",
"A comprehensive guide on identifying users in Formbricks without compromising privacy. Learn how to set User ID, email, and custom attributes to optimize survey targeting, recontact users, and control survey intervals, all while respecting user anonymity.",
};
#### Attributes
@@ -15,7 +15,7 @@ Once the Formbricks widget is loaded on your web app, our SDK exposes methods fo
## Setting User ID
You can use the `setUserId` function to identify a user with any string. It's best to use the default identifier you use in your app (e.g. unique id from database) but you can also anonymize these as long as they are unique for every user. This function can be called multiple times with the same value safely and stores the identifier in local storage. We recommend you set the User ID whenever the user logs in to your website, as well as after the installation snippet (if the user is already logged in).
<Col>
<CodeGroup title="Setting User ID">
```javascript
@@ -23,11 +23,11 @@ formbricks.setUserId("USER_ID");
```
</CodeGroup>
</Col>
## Setting User Email
You can use the setEmail function to set the user's email:
<Col>
<CodeGroup title="Setting Email">
```javascript
@@ -35,11 +35,11 @@ formbricks.setEmail("user@example.com");
```
</CodeGroup>
</Col>
### Setting Custom User Attributes
You can use the setAttribute function to set any custom attribute for the user (e.g. name, plan, etc.):
<Col>
<CodeGroup title="Setting Custom Attributes">
```javascript
@@ -47,11 +47,11 @@ formbricks.setAttribute("attribute_key", "attribute_value");
```
</CodeGroup>
</Col>
### Logging Out Users
When a user logs out of your webpage, make sure to log them out of Formbricks as well. This will prevent new activity from being associated with an incorrect user. Use the logout function:
<Col>
<CodeGroup title="Logging out User">
```javascript
@@ -59,3 +59,4 @@ formbricks.logout();
```
</CodeGroup>
</Col>

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "What are attributes and why are they useful?",
title: "Understanding User Attributes in Formbricks Surveys",
description:
"How to use attributes for user segmentation, enhancing survey targeting & results. Improve feedback quality and make data-driven decisions.",
"Dive into the importance of attributes in surveys. Learn how key-value pairs can significantly improve survey targeting, enhance feedback quality, and guide data-driven decisions with Formbricks.",
};
#### Attributes

View File

@@ -11,8 +11,8 @@ import PublishSurvey from "./publish-survey.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "Learn from Churn",
description: "To know how to decrease churn, you have to understand it. Use a micro-survey.",
title: "Mastering Churn Surveys with Formbricks | Essential Tips & Steps",
description: "Learn how to effectively utilize Formbricks' Churn Surveys to gain deeper insights into user departures. Dive into a step-by-step guide to craft, trigger, and optimize your churn surveys, ensuring you capture invaluable feedback at critical junctures",
};
#### Best Practices

View File

@@ -11,8 +11,10 @@ import WhenToAsk from "./when-to-ask.webp";
import CopyIds from "./copy-ids.webp";
export const meta = {
title: "Docs Feedback",
description: "Docs Feedback allows you to measure how clear your documentation is.",
title:
"Integrate Docs Feedback in Your Website: A Step-by-Step Guide on getting feedback on your Documentation with Formbricks",
description:
"Learn the step-by-step process to effectively measure the clarity of your documentation using Formbricks Cloud. Dive into best practices, setting up cloud environments, integrating feedback widgets on your frontend, and connecting to the Formbricks API for a seamless user experience.",
};
#### Best Practices
@@ -48,7 +50,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={SwitchToDev}
alt="switch to dev environment"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
3. Then, create a survey using the template “Docs Feedback”:
@@ -57,7 +59,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={DocsTemplate}
alt="select docs template"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
4. Change the Internal Question ID of the first question to **“isHelpful”** to make your life easier 😉
@@ -66,15 +68,14 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={ChangeId}
alt="switch to dev environment"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
5. In the same way, you can change the Internal Question ID of the _Please elaborate_ question to **“additionalFeedback”** and the one of the _Page URL_ question to **“pageUrl”**.
<Note>
## Answers need to be identical
If you want different answers than “Yes 👍” and “No 👎” you need update the choices accordingly. They have to
be identical to the frontend we're building in the next step.
## Answers need to be identical If you want different answers than “Yes 👍” and “No 👎” you need update the
choices accordingly. They have to be identical to the frontend we're building in the next step.
</Note>
6. Click on “Continue to Settings or select the audience tab manually. Scroll down to “When to ask” and create a new Action:
@@ -83,7 +84,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={WhenToAsk}
alt="set up when to ask card"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
7. Our goal is to create an event that never fires. This is a bit nonsensical because it is a workaround. Stick with me 😃 Fill the action out like on the screenshot:
@@ -92,7 +93,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={AddAction}
alt="add action"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
className="rounded"
/>
@@ -102,7 +103,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
src={SelectNonevent}
alt="select nonevent"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
**Youre all setup in Formbricks Cloud for now 👍**
@@ -110,9 +111,8 @@ To get this running, you'll need a bit of time. Here are the steps we're going t
### 2. Build the frontend
<Note>
## Your frontend might work differently
Your frontend likely looks and works differently. This is an example specific to our tech stack. We want to illustrate
what you should consider building yours 😊
## Your frontend might work differently Your frontend likely looks and works differently. This is an example
specific to our tech stack. We want to illustrate what you should consider building yours 😊
</Note>
Before we start, lets talk about the widget. It works like this:
@@ -132,20 +132,21 @@ This allows us to capture and analyze partial feedback where the user is not wil
src={DocsNavi}
alt="doc navigation"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
className="rounded"
/>
Locate that file. We are using the [Tailwind Template “Syntax”](https://tailwindui.com/templates/syntax) for our docs. Here is our [Layout.tsx](https://github.com/formbricks/formbricks/blob/main/apps/formbricks-com/components/docs/Layout.tsx) file.
3. Write the frontend code for the widget. Here is the full component (we break it down right below):
<Col>
<CodeGroup title="Entire Widget">
```tsx
import { useState } from "react";
import { handleFeedbackSubmit, updateFeedback } from "../../lib/handleFeedbackSubmit";
import { Popover, PopoverTrigger, PopoverContent, Button } from "@formbricks/ui";
import { Popover, PopoverTrigger, PopoverContent } from "@formbricks/ui/Popover";
import { Button } from "@formbricks/ui/Button";
import { useRouter } from "next/router";
export default function DocsFeedback() {
@@ -216,11 +217,11 @@ export default function DocsFeedback() {
```
</CodeGroup>
</Col>
**Lets break it down!**
Setting the local states and getting the current URL:
<Col>
<CodeGroup title="State Management">
```tsx
@@ -232,9 +233,9 @@ const [freeText, setFreeText] = useState(""); // to locally store the additional
```
</CodeGroup>
</Col>
Disabling feedback if config environment variables are not set properly:
<Col>
<CodeGroup title="Disable feedback if incorrect config env vars">
```tsx
@@ -248,9 +249,9 @@ if (
```
</CodeGroup>
</Col>
The actual frontend (read comments):
<Col>
<CodeGroup title="Actual Frontend">
```tsx
@@ -307,13 +308,13 @@ return (
```
</CodeGroup>
</Col>
## 3. Connecting to the Formbricks API
The last step is to hook up your sparkling new frontend to the Formbricks API. To do so, we followed the “[Create Response](/docs/client-api/create-response)” and “[Update Response](/docs/client-api/update-response)” pages in our docs.
Here is the code for the `handleFeedbackSubmit` function with comments:
<Col>
<CodeGroup title="handleFeedbackSubmit() function definition">
```tsx
@@ -356,9 +357,9 @@ export const handleFeedbackSubmit = async (YesNo, pageUrl) => {
```
</CodeGroup>
</Col>
And this is the `updateFeedback` function with comments:
<Col>
<CodeGroup title="updateFeedback() function definition">
```tsx
@@ -399,7 +400,7 @@ export const updateFeedback = async (freeText, responseId) => {
```
</CodeGroup>
</Col>
Thats almost it! 🤸
## 4. Setting it up for testing
@@ -411,10 +412,10 @@ Before you roll it out in production, you want to test it. To do so, you need tw
When you are on the survey detail page, youll find both of them in the URL:
<Image src={CopyIds} alt="copy IDs" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
<Image src={CopyIds} alt="copy IDs" quality="100" className="max-w-full rounded-lg sm:max-w-3xl" />
Now, you have to replace the IDs and the API host accordingly in your `handleFeedbackSubmit`:
<Col>
<CodeGroup title="Replace the ID and API accordingly">
```tsx
@@ -431,9 +432,9 @@ Now, you have to replace the IDs and the API host accordingly in your `handleFee
```
</CodeGroup>
</Col>
And lastly, in the `updateFeedback` function
<Col>
<CodeGroup title="Replace the ID and API here as well">
```tsx
@@ -445,6 +446,7 @@ And lastly, in the `updateFeedback` function
```
</CodeGroup>
</Col>
### Youre good to go! 🎉
Something doesnt work? Check your browser console for the error.

View File

@@ -10,8 +10,8 @@ import RecontactOptions from "./recontact-options.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "Feature Chaser",
description: "Follow up with users who used a specific feature. Gather feedback and improve your product.",
title: "Setting Up Feature Chaser Surveys with Formbricks: A Comprehensive Guide",
description: "Learn how to harness the power of Formbricks to gather targeted user feedback on specific features. Dive deep into creating, triggering, and publishing the Feature Chaser survey to enhance your product with actionable insights for specific users.",
};
#### Best Practices

View File

@@ -12,8 +12,8 @@ import SelectAction from "./select-feedback-button-action.webp";
import RecontactOptions from "./set-recontact-options.webp";
export const meta = {
title: "Feedback Box",
description: "The Feedback Box gives your users a direct channel to share their feedback and feel heard.",
title: "Implementing the Feedback Box with Formbricks: A Step-by-Step Tutorial",
description: "Unlock user insights effortlessly! Discover how to set up the Feedback Box in your app using Formbricks, allowing your users to provide real-time feedback. Follow our comprehensive guide to enhance user experience and respond rapidly to feedback",
};
#### Best Practices

View File

@@ -10,8 +10,8 @@ import RecontactOptions from "./recontact-options.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "Improve Trial Conversion",
description: "Understand how to improve the trial conversions to get more paying customers.",
title: "Boost Your Trial Conversion Rates with Formbricks: Comprehensive Guide",
description: "Unlock the secret to converting more trial users into paying customers using Formbricks. Understand insights behind trial cancellations and tailor your offering to fit user needs. Dive into our step-by-step tutorial and improve your conversion strategy today",
};
#### Best Practices

View File

@@ -13,8 +13,8 @@ import RecontactOptions from "./recontact-options.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "In-app Interview Prompt",
description: "Invite only power users to schedule an interview with your product team.",
title: "Maximize User Interview Participation with In-app Interview Prompts",
description: "Engage with your power users seamlessly using Formbricks' In-app Interview Prompt. Ditch traditional email invites and experience way more more respondents. Dive into our comprehensive guide on setting up auto-scheduled interviews today and enhance your user understanding",
};
#### Best Practices
@@ -125,7 +125,7 @@ Generally, we have two types of user actions: Page views and clicks. The Intervi
2. **innerText & CSS-Selector:** When a user clicks an element (like a button) with a specific text content or CSS selector, the prompt will be displayed as long as the other conditions also match.
<div className="grid grid-cols-2 space-x-2">
<div className="flex max-w-full flex-col sm:max-w-3xl lg:gap-1">
<Image src={ActionCSS} alt="Add CSS action" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
<Image
src={ActionInner}

View File

@@ -10,8 +10,8 @@ import RecontactOptions from "./recontact-options.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "Product-Market Fit Survey",
description: "The Product-Market Fit survey helps you measure, well, Product-Market Fit (PMF).",
title: "How to Set Up a Product-Market Fit Survey Using Formbricks - Step-by-Step Guide",
description: "Learn to leverage Formbricks to create and implement a Product-Market Fit survey in your web app. Follow our detailed step-by-step guide to measure and understand your PMF effectively. Ensure high data quality, efficient triggers, and actionable insights.",
};
#### Best Practices
@@ -96,8 +96,8 @@ This way you make sure that you separate potentially misleading opinions from va
### 4. Set up a trigger for the Product-Market Fit survey:
You need a trigger to display the survey but in this case, the filtering does all the work. Its up to you to decide to display the survey after the user viewed a specific subpage (pageURL) or after clicking an element. Have a look at the [Actions manual](/docs/actions/why) if you are not sure how to set them up:
<div className="grid grid-cols-2 space-x-2">
<Col>
<div>
<Image src={ActionCSS} alt="Add CSS action" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
<Image
src={ActionPageurl}
@@ -106,16 +106,16 @@ You need a trigger to display the survey but in this case, the filtering does al
className="rounded-lg max-w-full sm:max-w-3xl"
/>
</div>
</Col>
### 5. Select Action in the “When to ask” card
<Col>
<Image
src={SelectAction}
alt="Select PMF trigger button action"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
</Col>
### 6. Last step: Set Recontact Options correctly
Lastly, scroll down to “Recontact Options”. Here you have to choose the correct settings to make sure your data remains of high quality. You want to make sure that this survey is only responded to once per user. It is up to you to decide if you want to display it several times until the user responds:

View File

@@ -3,8 +3,8 @@ import Image from "next/image";
import DemoApp from "./demoapp.webp";
export const meta = {
title: "Demo App",
description: "To test in-app surveys, trigger actions and set attributes, you can use the Demo App.",
title: "Formbricks Demo App Guide: Play around with Formbricks",
description: "To test in-app surveys, trigger actions and set attributes, you can use the Demo App. This guide provides hands-on examples of sending both code and no-code actions",
};
#### Contributing
@@ -20,7 +20,7 @@ To play around with the in-app [User Actions](/docs/actions/why), you can use th
### Code Action
This button sends a <a href="/docs/actions/code">Code Action</a> to the Formbricks API called 'Code Action'. You will find it in the Actions Tab.
<Col>
<CodeGroup title="Track Code action">
```javascript
@@ -28,11 +28,11 @@ formbricks.track("Code Action");
```
</CodeGroup>
</Col>
### No Code Action
This button sends a <a href="/docs/actions/no-code">No Code Action</a> as long as you created it beforehand in the Formbricks App. For it to work, you need to add the No Code Action within Formbricks.
<Col>
<CodeGroup title="Track No-Code action">
```tsx
@@ -40,11 +40,11 @@ This button sends a <a href="/docs/actions/no-code">No Code Action</a> as long a
```
</CodeGroup>
</Col>
### Set Plan to "Free"
This button sets the <a href="/docs/attributes/custom-attributes">attribute</a> 'Plan' to 'Free'. If the attribute does not exist, it creates it.
<Col>
<CodeGroup title="Set Plan to Free">
```tsx
@@ -52,11 +52,11 @@ formbricks.setAttribute("Plan", "Free");
```
</CodeGroup>
</Col>
### Set Plan to "Paid"
This button sets the <a href="/docs/attributes/custom-attributes">attribute</a> 'Plan' to 'Paid'. If the attribute does not exist, it creates it.
<Col>
<CodeGroup title="Set Plan to Paid">
```tsx
@@ -64,11 +64,11 @@ formbricks.setAttribute("Plan", "Paid");
```
</CodeGroup>
</Col>
### Set Email
This button sets the <a href="/docs/attributes/identify-users">user email</a> 'test@web.com'
<Col>
<CodeGroup title="Set Email">
```tsx
@@ -76,11 +76,11 @@ formbricks.setEmail("test@web.com");
```
</CodeGroup>
</Col>
### Set UserId
This button sets an external <a href="/docs/attributes/identify-users">user ID</a> to 'THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING'
<Col>
<CodeGroup title="Set User ID">
```tsx
@@ -88,3 +88,4 @@ formbricks.setUserId("THIS-IS-A-VERY-LONG-USER-ID-FOR-TESTING");
```
</CodeGroup>
</Col>

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

View File

@@ -0,0 +1,141 @@
import Image from "next/image";
import GitpodPorts from "./gitpod-ports.webp";
import GitpodAuth from "./gitpod-auth.webp";
import GitpodNewWorkspace from "./gitpod-new-workspace.webp";
import GitpodPreparing from "./gitpod-preparing.webp";
import GitpodRunning from "./gitpod-running.webp";
export const meta = {
title: "Gitpod Setup",
description:
"With one click, you can setup the Formbricks developer environment in your browser using Gitpod",
};
#### Contributing
# Gitpod
### One Click Setup
- This will open a fully configured workspace in your browser with all the necessary dependencies already installed.
- Click the button below to open this project in Gitpod.
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/formbricks/formbricks)
## Gitpod Setup Overview
**Building custom image for the workspace:**
- This includes : Installing `yq` and `turbo` globally before the workspace starts. This is accomplished within the `.gitpod.Dockerfile` along with starting upon a base custom image building on [workspace-full](https://hub.docker.com/r/gitpod/workspace-full/dockerfile).
**Initialization of Formbricks:**
- During the prebuilds phase, we initialize Formbricks by performing the following tasks:
1. Setting up environment variables.
2. Installing monorepo dependencies.
3. Installing Docker images by extracting them from the `packages/database/docker-compose.yml` file.
4. Building the @formbricks/js component.
- When the workspace starts:
1. Waiting for web and demo apps to start and openening the `apps/demo/.env` file automatically such that users can start playing around with the demo app by configuring `NEXT_PUBLIC_FORMBRICKS_ENVIRONMENT_ID` straight away!
**Web Component Initialization:**
- we initialize the @formbricks/web component during prebuilds. This involves:
1. Installing build dependencies for the `@formbricks/web#go` task from turbo.json in prebuilds to save time.
2. Starting PostgreSQL and Mailhog containers for running migrations in prebuilds.
3. To prevent the "Init" task from running indefinitely due to prebuild rules, a cleanup `docker compose down` step i.e. `db:down` is added to `turbo.json`. This step is designed to halt the execution of containers that are currently running.
- When the workspace starts:
1. Initializing environment variables.
2. Replacing `NEXT_PUBLIC_WEBAPP_URL` and `NEXTAUTH_URL` to take in Gitpod URL's ports when running on VSCode browser.
3. Starting the `@formbricks/web` dev environment.
**Demo Component Initialization:**
- Similar to the web component, the demo component is also initialized during prebuilds. This includes:
1. Installing build dependencies for the `formbricks/demo#go` task from turbo.json in prebuilds to save time.
2. Caching hits and replaying builds from the `@formbricks/js` component.
- When the workspace starts:
1. Initializing environment variables.
2. Replaces `NEXT_PUBLIC_FORMBRICKS_API_HOST` to take in Gitpod URL's ports when running on VSCode browser.
3. Starting the `@formbricks/demo` dev environment.
**GitHub Prebuilds Configuration:**
- This configures GitHub Prebuilds for the master branch, pull requests, and adding comments. This helps automate the prebuild process for the specified branches and actions.
**VSCode Extensions:**
- This includes a list of VSCode extensions that are added to the configuration when using Gitpod. These extensions can enhance the development experience within Gitpod.
## Gitpod Guide
### 1. Browser Redirection
After clicking the one-click setup button, Gitpod will open a new tab or window. Please ensure that your browser allows redirection to successfully access the services:
### 2. Authorizing in Gitpod
<Image src={GitpodAuth} alt="Gitpod Auth Page" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
- This is the Gitpod Authentication Page. It appears when you click the "Open in GitPod" button and Gitpod needs to authenticate your access to the workspace. Click on 'Continue With Github' to authorize your GitPod session.
### 3. Creating a New Workspace
<Image src={GitpodNewWorkspace} alt="Gitpod New Worskpace Page" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
- After authentication, Gitpod asks to create a new workspace for you. This page displays the configurations of your workspace.
- You can use either choose either VS Code Browser or VS Code Desktop editor with the 'Standard Class' for your workspace class.
- If you opt for the VS Code Desktop, follow the following steps
1. Gitpod will prompt you to grant access to the VSCode app. Once approved, install the GitPod extension from the VSCode Marketplace and follow the prompts to authorize the integration.
2. Change the `WEBAPP_URL` and the `NEXTAUTH_URL` to `https://localhost:3000`
### 4. Gitpod preparing the created Workspace
<Image src={GitpodPreparing} alt="Gitpod Preparing Worskpace Page" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
- Gitpod is preparing your workspace with all the necessary dependencies and configurations. You will see this page while Gitpod sets up your development environment.
### 5. Gitpod running the Workspace
<Image src={GitpodRunning} alt="Gitpod Running Workspace Page" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
- Once the workspace is fully prepared, voila, it enters the running state. You can start working on your project in this environment.
### Ports and Services
Here are the ports and corresponding URLs for the services within your Gitpod environment:
- **Port 3000**:
- **Service**: Demo App
- **Description**: This port hosts the demo application of your project. You can access and interact with your application's demo by navigating to this port.
- **Port 3001**:
- **Service**: Formbricks website
- **Description**: This port hosts the [Formbricks](https://formbricks.com) website, which contains documents, pricing, blogs, best practices, and concierge service.
- **Port 3002**:
- **Service**: Formbricks In-product Survey Demo App
- **Description**: This app helps you test your in-app surveys. You can create and test user actions, create and update user attributes, etc.
- **Port 5432**:
- **Service**: PostgreSQL Database Server
- **Description**: The PostgreSQL DB is hosted on this port.
- **Port 1025**:
- **Service**: SMPT server
- **Description**: SMTP Server for sending and receiving email messages. This server is responsible for handling email communication.
- **Port 8025**:
- **Service**: Mailhog
### Accessing port URLs
1. **Direct URL Composition**:
- You can access the dedicated port URL by pre-pending the port number to the workspace URL.
- For example, if you want to access port 3000, you can use the URL format: `3000-yourworkspace.ws-eu45.gitpod.io`.
2. **Using [gp CLI](https://www.gitpod.io/docs/references/gitpod-cli)**:
- Gitpod provides a convenient command, `gp url`, to quickly retrieve the URL for a specific port.
- Simply use the command followed by the desired port number. For example, to get the URL for port 3000, run: `gp url 3000`.
3. **Listing All Open Port URLs**:
- If you prefer to see a list of all open port URLs at once, you can use the `gp ports list` command.
- Running this command will display a list of ports along with their corresponding URLs.
4. **Viewing All Ports in Panel**:
- Gitpod also offers a user-friendly 'Ports' tab in the Gitpod panel.
- Click on the 'Ports' tab to view a list of all open ports and their respective URLs.
<Image src={GitpodPorts} alt="Gitpod Ports tab" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
These URLs and port numbers represent various services and endpoints within your Gitpod environment. You can access and interact with these services by the Port URL for the respective service.
Still cant figure it out? Join our [Discord](https://discord.com/invite/3YFcABF2Ts)!

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

View File

@@ -0,0 +1,128 @@
import Image from "next/image";
import CorsHandling from "./cors-handling-in-api.webp";
export const meta = {
title: "Formbricks Code Contribution Guide: Best Practices and Standards",
description:
"Effortlessly Navigate Your Contribution Journey with Formbricks' Coding Guidelines and PR Review Process",
};
#### Contributing
# How we Code at Formbricks
Thank you for choosing to contribute to Formbricks. Before you start, please familiarize yourself with our coding standards and best practices, as these are key criteria for pull request reviews. Your contributions are greatly valued, and if you have any questions about these guidelines, please don't hesitate to ask.
**Table of content**
- Use Typescript types throughout the application
- Always prioritise Server components
- Fetch data only in server components
- Use Server-Action for mutations
- Use service abstraction instead of direct database calls
- Handle authentication and CORS in management APIs
- Always Document API changes
- Constants should be in the packages folder
- Types should be in the packages folder
- How we handle Pull Requests
- Read environment variables from `.env.mjs`
---
## Use Typescript types throughout the application
The entire codebase is written in TypeScript, and it is crucial that every new piece of code is thoroughly and accurately typed. Instead of resorting to using the `any` type for variables, please ensure that you explicitly specify the appropriate type.
## Always prioritise Server components
When it comes to prioritizing the development of our components, our main focus is on building them as server components. This ensures that they are optimized for server-side rendering and can handle any necessary interactivity seamlessly. However, in cases where a component requires client-side interactivity, we are able to adapt it into a client component. If you would like to learn more about the advantages and benefits of server components, we highly recommend reading the comprehensive documentation provided by Next.js, which can be accessed [here](https://nextjs.org/docs/app/building-your-application/rendering/server-components).
## Fetch data only in server components
In order to ensure that both data fetching and rendering take place on the server, it is expected that actions to fetch data from the server will be performed within server components. This approach is prioritized as discussed in the previous point, which provides further details on the benefits and importance of server components.
**Note**: Data fetching is done in the `page.tsx` of the route or the corresponding server component that needs this data.
## Use Server-Action for mutations
Server actions are used to perform server actions in client components. For example, a button click (client-side) that should change something in the database. Server actions should be placed in an `actions.ts` file within the specific route to maintain code organization and facilitate efficient development.
## Use service abstraction instead of direct database calls
We utilize [prisma](https://www.prisma.io/) as our Object-Relational Mapping (ORM) tool to interact with the database. This implies that when you need to fetch or modify data in the database, you will be utilizing prisma. All prisma calls should be written in the services folder `packages/lib`, and before creating a new service, please ensure that one does not already exist.
## Handle authentication and CORS in management APIs
We have two APIs: Management API and Client API.
The public endpoints of the Client API are used by the link survey and `formbricks-js` to send responses and displays to formbricks. Client APIs can be found in `apps/web/app/api/v1/client`
The Management API offers the same functionality as the management frontend and can be used to create surveys, view responses or change account settings. The endpoints require an api key that the user can obtain in the management frontend. Management APIs can be found in `apps/web/app/api/v1/management`.
Please keep the following in mind:
- When dealing with Management APIs always make sure to require authentication via API keys and a sufficient authorization check.
- Make sure to handle CORS requests in any new Client API endpoint you create as these are called from the browser in link surveys or `formbricks-js`. Example below:
<Image
src={CorsHandling}
alt="Cors handling within an API"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
## Always Document API changes
It is imperative that any and all modifications or updates made to the client API are thoroughly and comprehensively documented. This documentation should provide clear and detailed information about the nature of the changes, their impact on existing functionality, and any new features or improvements introduced. This practice not only ensures transparency and accountability but also aids developers, both internal and external, in understanding and effectively utilizing the API, ultimately fostering a more robust and user-friendly development ecosystem.
## Constants should be in the packages folder
You should store constants in `packages/lib/constants`
## Types should be in the packages folder
You should store type in `packages/types/v1`
## Read environment variables from `.env.mjs`
Environment variables (`process.env`) shouldnt be accessed directly but be added in the `.env.mjs` and should be accessed from here. This practice helps us ensure that the variables are typesafe.
## How we handle Pull Requests
We have a number of requirements for PRs to ensure they are as easy to review as possible and to ensure that they are up to standard with the code.
### Code change
When submitting a pull request, it is important to avoid combining multiple changes or issues into a single PR. By keeping each PR focused on a specific change or issue, it becomes easier and faster to review. Additionally, separating changes into individual PRs makes it easier to test each change independently. This allows for more efficient and thorough testing, ensuring that each change is properly validated before merging.
### Title & Content
We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/). You should provide a short and concise title. Dont put something generic (e.g. bug fixes), and instead mention more specifically what your PR achieves, for instance “fix: dropdown not expanding on survey page”.
For the PR description, you should go into much greater detail about what your PR adds or fixes. Firstly, the description should include a link to any relevant issues or discussions surrounding the feature or bug that your PR addresses.
### Feature PRs
Give a functional overview of how your feature works, including how the user can use the feature. Then, share any technical details in an overview of how the PR works (e.g. “Once the user enters their password, the password is hashed using BCrypt and stored in the Users database field”).
### Bug Fix PRs
Give an overview of how your PR fixes the bug both as a high-level overview and a technical explanation of what caused the issue and how your PR resolves this.
Add a short video or screenshots of what your PR achieves. Loom is a great way of sharing short videos however you can upload your videos directly to the PR description.
### Code Quality & Styling
All submitted code must match our **[code styling](https://www.notion.so/Code-Styling-65ddc5dd2deb4b28a9876f1f7cc89ca9?pvs=21)** standards. We will reject pull requests that differ significantly from our standardised code styles.
All code is automatically checked by Github actions, and will notify you if there are any issues with the code that you submit. We require that code passes these quality checks before merging.
### PR review process
At the moment Matti is responsible for approving and merging pull requests, so please make sure to request his review when opening the PR and make the changes he requests in order to merge the PR.
### Making a Pull Request
- Be sure to **[check the "Allow edits from maintainers" option](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)** while creating your PR.
- If your PR refers to or fixes an issue, be sure to add **`refs #XXX`** or **`fixes #XXX`** to the PR description. Replacing **`XXX`** with the respective issue number. See more about **[Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)** .
- Be sure to fill the PR Template accordingly.

View File

@@ -1,6 +1,7 @@
export const meta = {
title: "Contribution Guide",
description: "How to contribute to Formbricks",
title: "Formbricks Open Source Contribution Guide: How to Enhance yourself and Contribute to Formbricks",
description:
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Discord",
};
#### Contributing
@@ -36,3 +37,11 @@ We are currently working on having a clear [Roadmap](https://github.com/formbric
But you can also pick a feature that is not already on the roadmap if you think it creates a positive impact for Formbricks.
If you are at all unsure, just raise it as an enhancement issue first and tell us that you like to work on it, and we'll very quickly respond.
## Contributor License Agreement (CLA)
To be able to keep working on Formbricks over the coming years, we need to collect a CLA from all relevant contributors.
Please note that we can only get your contribution merged when we have a CLA signed by you.
To access the CLA form, please click [here](https://formbricks.com/clmyhzfrymr4ko00hycsg1tvx)

View File

@@ -1,6 +1,6 @@
export const meta = {
title: "Setup Dev Environment",
description: "Setup a development environment for Formbricks.",
title: "Formbricks Development Setup: Complete Guide to Local Environment Configuration for Dev",
description: "Step-by-step guide to setting up your local development environment for Formbricks. Includes installing essential tools like Node.JS, pnpm, and Docker, and accessing the entire Formbricks stack including the Demo app and the main website",
};
#### Contributing
@@ -14,7 +14,7 @@ To get the project running locally on your machine you need to have the followin
- [Docker](https://www.docker.com/) (to run PostgreSQL / MailHog)
1. Clone the project:
<Col>
<CodeGroup title="Git clone Formbricks monorepo">
```bash
@@ -22,9 +22,9 @@ To get the project running locally on your machine you need to have the followin
```
</CodeGroup>
</Col>
and move into the directory
<Col>
<CodeGroup title="Move into the Formbricks monorepo">
```bash
@@ -32,9 +32,9 @@ To get the project running locally on your machine you need to have the followin
```
</CodeGroup>
</Col>
1. Install Node.JS packages via pnpm. Don't have pnpm? Get it [here](https://pnpm.io/installation)
<Col>
<CodeGroup title="Install dependencies via pnpm">
```bash
@@ -42,9 +42,9 @@ To get the project running locally on your machine you need to have the followin
```
</CodeGroup>
</Col>
1. Create a `.env` file based on `.env.example`. It's already preset to work with the docker-compose setup but you can also change values if needed.
<Col>
<CodeGroup title="Define environment variables">
```bash
@@ -52,9 +52,20 @@ To get the project running locally on your machine you need to have the followin
```
</CodeGroup>
</Col>
1. Generate a secret value mandatory to be set for the key ENCRYPTION_KEY in the .env file. You can use the following command to generate the random string of required length:
<Col>
<CodeGroup title="Set value of ENCRYPTION_KEY">
```bash
openssl rand -base64 24
```
</CodeGroup>
</Col>
1. Make sure you have [`Docker`](https://docs.docker.com/compose/) & [`docker-compose`](https://docs.docker.com/compose/) installed and running on your machine. Then run the following command to start the formbricks dev setup:
<Col>
<CodeGroup title="Start Formbricks Dev Setup">
```bash
@@ -62,7 +73,7 @@ To get the project running locally on your machine you need to have the followin
```
</CodeGroup>
</Col>
This starts the Formbricks main app (plus all its dependencies) as well as the following services using Docker:
- a `postgres` container for hosting your database,
@@ -75,7 +86,7 @@ To get the project running locally on your machine you need to have the followin
### Build
To build all apps and packages and check for build errors, run the following command:
<Col>
<CodeGroup title="Build Formbricks stack">
```bash
@@ -83,11 +94,11 @@ pnpm build
```
</CodeGroup>
</Col>
### Access Demo app
To run the [Demo app](/docs/contributing/demo), run the following command in a separate terminal window:
<Col>
<CodeGroup title="Start Formbricks Demo App">
```bash
@@ -95,13 +106,13 @@ pnpm dev --filter=demo
```
</CodeGroup>
</Col>
You can now access the Demo app on [http://localhost:3002](http://localhost:3002).
### Access Formbricks website
If you want to make changes to the Formbricks website, e.g. to update the documentation, run the following command in a separate terminal window:
<Col>
<CodeGroup title="Start Formbricks Website">
```bash
@@ -109,5 +120,5 @@ pnpm dev --filter=formbricks-com
```
</CodeGroup>
</Col>
You can now access the Formbricks website on [http://localhost:3001](http://localhost:3001).

View File

@@ -5,16 +5,16 @@ import UncaughtPromise from "./uncaught-promise.webp";
import Logout from "./logout.webp";
export const meta = {
title: "Troubleshooting",
title: "Formbricks Troubleshooting Guide: How to Solve & Debug Common Issues",
description:
"Formbricks is a complex application in constant development. Sometimes, things don't go as planned. Here are some tips to help you troubleshoot.",
"Facing issues with Formbricks? This troubleshooting guide covers frequently encountered problems, from Prisma migrations to package errors and more. Detailed solutions, accompanied by visual aids, ensure a smoother user experience with Formbricks",
};
#### Contributing
# Troubleshooting
Here you'll find help with Frequently Recurring Problems
Here you'll find help with frequently recurring problems
## "The app doesn't work after doing a prisma migration"
@@ -24,7 +24,7 @@ This can happen but fear not, the fix is easy: Delete the application storage of
src={ClearAppData}
alt="Demo App Preview"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
## "I ran 'pnpm i' but there seems to be an error with the packages"
@@ -34,7 +34,7 @@ If nothing helps, run `pnpm clean` and then `pnpm i` again. This solves a lot.
## "I get a full-screen error with cryptic strings"
This usually happens when the Formbricks Widget wasn't correctly or completely built.
<Col>
<CodeGroup title="Build js library first and then run again">
```bash
@@ -45,11 +45,11 @@ pnpm dev
```
</CodeGroup>
</Col>
## My machine struggles with the repository
Since we're working with a monorepo structure, the repository can get quite big. If you're having trouble working with the repository, try the following:
<Col>
<CodeGroup title="Only run the required project">
```bash {{ title: 'Formbricks Web-App' }}
@@ -65,7 +65,7 @@ pnpm dev --filter=demo...
```
</CodeGroup>
</Col>
However, in our experience it's better to run `pnpm dev` than having two terminals open (one with the Formbricks app and one with the demo).
## Uncaught (in promise) SyntaxError: Unexpected token !DOCTYPE ... is not valid JSON
@@ -74,9 +74,9 @@ However, in our experience it's better to run `pnpm dev` than having two termina
src={UncaughtPromise}
alt="Uncaught promise"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
This happens when you're using the Demo App and delete the Person within the Formbricks app which the widget is currently connected with. We're fixing it, but you can also just logout your test person and reload the page to get rid of it.
<Image src={Logout} alt="Logout Person" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
<Image src={Logout} alt="Logout Person" quality="100" className="max-w-full rounded-lg sm:max-w-3xl" />

View File

@@ -0,0 +1,14 @@
import FAQ from "@/components/docs/docsFaq";
export const meta = {
title: "FAQ",
description: "Frequently Asked Questions about Formbricks and how to use it.",
};
#### FAQ
# Frequently Asked Questions
Here you'll find help with frequently recurring problems. If you can't find an answer to your question, please join our [Discord server](https://formbricks.com/discord).
<FAQ />

View File

@@ -6,8 +6,9 @@ import WidgetConnected from "./widget-connected.webp";
import ReactApp from "./react-in-app-survey-app-popup-form.webp";
export const metadata = {
title: "Framework Guides",
description: "Explore all the possible ways you can integrate Formbricks into your application.",
title: "Integrate Formbricks: Comprehensive Framework Guide & Integration Tutorial",
description:
"Master the integration of Formbricks into your application with our detailed guides. From HTML to ReactJS, NextJS, and VueJS, get step-by-step instructions and ensure seamless setup.",
};
# Framework Guides
@@ -30,7 +31,7 @@ Before getting started, make sure you have:
src={SetupChecklist}
alt="Step 2 - Setup Checklist"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
---
@@ -39,16 +40,17 @@ Before getting started, make sure you have:
All you need to do is copy a `<script>` tag to your HTML head, and thats about it!
<Col>
<CodeGroup title="HTML">
```html {{ title: 'index.html' }}
<!-- START Formbricks Surveys -->
<script type="text/javascript">
!function(){var t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://unpkg.com/@formbricks/js@^1.0.0/dist/index.umd.js";var e=document.getElementsByTagName("script")[0];e.parentNode.insertBefore(t,e),setTimeout(function(){window.formbricks=window.js;window.formbricks.init({environmentId: "<your-environment-id>", apiHost: "<api-host>"})},500)}();
!function(){var t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://unpkg.com/@formbricks/js@^1.1.0/dist/index.umd.cjs";var e=document.getElementsByTagName("script")[0];e.parentNode.insertBefore(t,e),setTimeout(function(){window.formbricks.init({environmentId: "<your-environment-id>", apiHost: "<api-host>"})},500)}();
</script>
<!-- END Formbricks Surveys -->
```
</CodeGroup>
</Col>
### Required Customizations to be Made
<Properties>
@@ -70,6 +72,7 @@ Refer our [Example HTML project](https://github.com/formbricks/examples/tree/mai
Install the Formbricks SDK using one of the package managers ie `npm`,`pnpm`,`yarn`.
<Col>
<CodeGroup title="Install Formbricks JS library">
```shell {{ title: 'npm' }}
npm install --save @formbricks/js
@@ -82,9 +85,9 @@ yarn add @formbricks/js
```
</CodeGroup>
</Col>
Now, update your App.js/ts file to initialise Formbricks.
<Col>
<CodeGroup title="src/App.js">
```js
@@ -107,7 +110,7 @@ export default App;
```
</CodeGroup>
</Col>
### Required Customizations to be Made
<Properties>
@@ -129,7 +132,7 @@ The app initializes 'formbricks' when it's loaded in a browser environment (due
src={ReactApp}
alt="In app survey in React app for micro surveys"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
Refer our [Example ReactJs project](https://github.com/formbricks/examples/tree/main/reactjs) for more help! Now visit the [Validate your Setup](#validate-your-setup) section to verify your setup!
@@ -147,6 +150,7 @@ guidelines for each convention below:
Code snippets for the integration for both conventions are provided to further assist you.
<Col>
<CodeGroup title="Install Formbricks JS library">
```shell {{ title: 'npm' }}
npm install --save @formbricks/js
@@ -159,9 +163,9 @@ yarn add @formbricks/js
```
</CodeGroup>
</Col>
### App Directory
<Col>
<CodeGroup title="app/formbricks.tsx">
```tsx {{title: 'Typescript'}}
"use client";
@@ -173,19 +177,19 @@ export default function FormbricksProvider() {
const pathname = usePathname();
const searchParams = useSearchParams();
useEffect(() => {
formbricks.init({
environmentId: "<environment-id>",
apiHost: "<api-host>",
debug: true, // remove when in production
});
}, []);
useEffect(() => {
formbricks.init({
environmentId: "<environment-id>",
apiHost: "<api-host>",
debug: true, // remove when in production
});
}, []);
useEffect(() => {
formbricks?.registerRouteChange();
}, [pathname, searchParams]);
useEffect(() => {
formbricks?.registerRouteChange();
}, [pathname, searchParams]);
return null;
return null;
}
````
@@ -207,11 +211,13 @@ export default function RootLayout({ children }: { children: React.ReactNode })
````
</CodeGroup>
</Col>
Refer our [Example NextJS App Directory project](https://github.com/formbricks/examples/tree/main/nextjs-app) for more help!
### Pages Directory
<Col>
<CodeGroup title="src/pages/_app.tsx">
```tsx {{ title: 'Typescript' }}
@@ -245,7 +251,7 @@ export default function App({ Component, pageProps }: AppProps) {
```
</CodeGroup>
</Col>
Refer our [Example NextJS Pages Directory project](https://github.com/formbricks/examples/tree/main/nextjs-pages) for more help!
### Required Customizations to be Made
@@ -283,6 +289,7 @@ Now visit the [Validate your Setup](#validate-your-setup) section to verify your
Integrating the Formbricks SDK with Vue.js is a straightforward process.
We will make sure the SDK is only loaded and used on the client side, as it's not intended for server-side usage.
<Col>
<CodeGroup title="Install Formbricks JS library">
```shell {{ title: 'npm' }}
npm install --save @formbricks/js
@@ -335,7 +342,7 @@ router.afterEach((to, from) => {
```
</CodeGroup>
</Col>
### Required Customizations to be Made
<Properties>
@@ -367,7 +374,7 @@ Once you have completed the steps above, you can validate your setup by checking
src={WidgetNotConnected}
alt="Widget isnt connected"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
To this:
@@ -376,9 +383,9 @@ To this:
src={WidgetConnected}
alt="Widget is connected"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
**Cant figure it out? [Join our Discord!](https://formbricks.com/discord)**
---
---

View File

@@ -14,8 +14,8 @@ import I11 from "./11-survey-logs-in-app-survey-popup.webp";
import ReactApp from "../framework-guides/react-in-app-survey-app-popup-form.webp";
export const meta = {
title: "Collect in app survey responses in 10 minutes",
description: "Get your first in app survey response in 10 minutes.",
title: "Formbricks Quickstart Guide: In-App Surveys Made Simple",
description: "Launch your first in-app survey effortlessly. Dive into our step-by-step guide to set up, integrate, and debug Formbricks in your web app in under 15 minutes.",
};
#### Getting Started

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

View File

@@ -0,0 +1,168 @@
import { Fence } from "@/components/shared/Fence";
import { Callout } from "@/components/shared/Callout";
import IntegrationTab from "./integrations-tab.webp";
import ConnectWithGoogle from "./connect-with-google.webp";
import GoogleConnected from "./google-connected.webp";
import LinkSurveyWithSheet from "./link-survey-with-sheet.webp";
import LinkWithQuestions from "./link-with-questions.webp";
import ListLinkedSurveys from "./list-linked-surveys.webp";
import DeleteConnection from "./delete-connection.webp";
import Image from "next/image";
export const meta = {
title: "n8n Setup",
description: "Wire up Formbricks with n8n and 350+ other apps",
};
#### Integrations
# Google Sheets
The Google Sheets integration allows you to automatically send responses to a Google Sheet of your choice.
<Note>
This feature is enabled by default in Formbricks Cloud but needs to be self-configured when running a
self-hosted version of Formbricks.
</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 Google Sheets integration.
<Image
src={IntegrationTab}
alt="Formbricks Integrations Tab"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
2. Now click on the "Connect with Google" button to authenticate yourself with Google.
<Image
src={ConnectWithGoogle}
alt="Connect Formbricks with your Google"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
3. You will now be taken to the Google OAuth page where you can select the Google account you want to use for the integration.
4. Once you have selected the account and completed the authentication process, you will be taken back to Formbricks Cloud and see the connected status as below:
<Image
src={GoogleConnected}
alt="Formbricks is now connected with Google"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
<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.
</Note>
6. Now click on the "Link New Sheet" button to link a new Google Sheet with Formbricks and a modal will open up.
<Image
src={LinkSurveyWithSheet}
alt="Link Formbricks with a Google Sheet"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
7. Select the Google Sheet you want to link with Formbricks and the Survey. On doing so, you will be asked with what questions' responses you want to feed in the Google Sheet. Select the questions and click on the "Link Sheet" button.
<Image
src={LinkWithQuestions}
alt="Select question to link with Google Sheet"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
8. On submitting, the modal will close and you will see the linked Google Sheet in the list of linked Google Sheets.
<Image
src={ListLinkedSurveys}
alt="List of linked Google Sheets"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
Congratulations! You have successfully linked a Google Sheet with Formbricks. Now whenever a response is submitted for the linked Survey, it will be automatically added to the linked Google Sheet.
## Setup in self-hosted Formbricks
Enabling the Google Sheets Integration in a self-hosted environment isn't easy and requires a setup using Google Cloud and changing the environment variables of your Formbricks instance.
<Note>This process is really complicated and we recommend using Formbricks Cloud for this feature.</Note>
We will first create a Google Cloud Project and then enable the Google Sheets API for it. Then we will create an OAuth Client ID and Client Secret for our Formbricks instance and set them as environment variables.
1. Go to the [Google Cloud Console](https://console.cloud.google.com/) and **create a new project**.
2. Now select the project you just created and go to the "**APIs & Services**" section.
3. Click on the "**Enable APIs and Services**" button and search for "**Google Sheets API**" and enable it.
4. Now go to the "**OAuth Consent screen**" section and select the **"External" User Type** if you want any Google User to be able to use the integration or select "Internal" if you want only the users of your Google Workspace to be able to use the integration.
5. Now provide it the details such as
- App name (Will **show up in the OAuth modal** when the user is asked to authenticate with Google)
- User support email (ideally should be **your email** for any support queries by the Users or Google)
- Developer contact information (ideally should be **your email** for any **support queries by Google**)
6. Now click on the "Save and Continue" button and you will be taken to the Scopes step.
7. 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` and click on the "Update" button:
8. Now Verify the scopes and click on the "Save and Continue" button.
9. Now go to the **"Test Users" section, skip the step**, and click the "Save and Continue" button.
10. You will now be shown a summary of the OAuth Consent Screen. Verify the details and Click on the "**Back to Dashboard**" button.
11. Now go to the "**Credentials**" section and click on the "**Create Credentials**" button and select "**OAuth Client ID**".
12. Select "**Web Application**" as the Application Type and provide it a name (this name will **not be visible** to your end users).
13. Now add your **public facing URL** in the "**Authorized JavaScript Origins**" section:
- https://`<your-public-facing-url`>
14. Now add the following URL in the "**Authorized redirect URIs**" section and click on the "**Create**" button:
- https://`<your-public-facing-url`>/api/google-sheet/callback
15. You will now be shown the **Client ID** and **Client Secret**. Copy them and set them as the **environment variables** in your Formbricks instance as:
- `GOOGLE_SHEETS_CLIENT_ID` - Client ID
- `GOOGLE_SHEETS_CLIENT_SECRET` - Client Secret
16. Also use the **same Authorized redirect URI** in the `GOOGLE_SHEETS_REDIRECT_URL` environment variable.
### By now, your environment variables should include the below ones as well:
- `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 the [Formbricks Cloud](#formbricks-cloud) section to link a Google Sheet with Formbricks.
## Remove Integration with Google Account
To remove the integration with Google Account,
1. Visit the Integrations tab in your Formbricks Cloud dashboard.
2. Select "Manage" button in the Google Sheets card.
3. Click on the "Connected with `<your-email-here`>" just before the "Link new Sheet" button.
4. It will now ask for a confirmation to remove the integration. Click on the "Delete" button to remove the integration. You can always come back and connect again with the same Google Account.
<Image
src={DeleteConnection}
alt="Delete Google Integration with Formbricks"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
## What data do you need?
- 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)
- 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:
1. **User Email**: To identify you (that's it, nothing else, we're opensource, see this in our codebase [here](https://github.com/formbricks/formbricks/blob/main/apps/web/app/api/google-sheet/callback/route.ts#L47C17-L47C25))
1. **Google Drive API**: To list all your google sheets (that's it, nothing else, we're opensource, see this method in our codebase [here](https://github.com/formbricks/formbricks/blob/main/packages/lib/googleSheet/service.ts#L13))
1. **Google Spreadsheet API**: To write to the spreadsheet you select (that's it, nothing else, we're opensource, see this method in our codebase [here](https://github.com/formbricks/formbricks/blob/main/packages/lib/googleSheet/service.ts#L70))
<Note>
We do not store any other information of yours! We value Privacy more than you and rest assured you're safe
with us!
</Note>
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -0,0 +1,136 @@
import Image from "next/image";
import UpdateQuestionId from "./update-question-id.webp";
import DuplicateSurvey from "./duplicate-survey.webp";
import CreateNewScenario from "./create-new-scenario.webp";
import SearchFormbricks from "./search-formbricks.webp";
import SelectTriggers from "./select-trigger.webp";
import CreateWebhook from "./create-webhook.webp";
import EnterApiKey from "./enter-api-key.webp";
import SelectSurvey from "./select-survey.webp";
import SubmitTestResponse from "./submit-test-response.webp";
import AddModule from "./add-module.webp";
import SelectFields from "./select-fields.webp";
import Result from "./result.webp";
import SelectAction from "./select-action.webp";
export const meta = {
title: "Formbricks Integration with Make.com: A Step-by-Step Guide",
description: "Discover how to seamlessly integrate Formbricks with Make.com. Dive into our comprehensive guide to set up scenarios, connect with a plethora of apps, and send your survey data to more than 1000 platforms.",
};
#### Integrations
# Make.com Setup
Make is a powerful tool to send information between Formbricks and thousands of apps. Here's how to set it up.
<Note>
### Nail down your survey first ?
Any changes in the survey cause additional work in the _Scenario_. It
makes sense to first settle on the survey you want to run and then get to setting up Make.
</Note>
## Step 1: Setup your survey incl. `questionId` for every question
Set up the `questionId`s of your survey questions before publishing.
<Image
src={UpdateQuestionId}
alt="Update Question ID"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
_Update the Question ID field in every question card under Advanced Settings._
<Note>
### Already published? Duplicate survey
You can only update the questionId before publishing the survey. If
already published, simply duplicate it.
<Image
src={DuplicateSurvey}
alt="Duplicate Survey"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
</Note>
## Step 2: Setup Make.com
Visit [Make.com](https://make.com) to start a new scenario.
<Image
src={CreateNewScenario}
alt="Create New Scenario"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
Search for `Formbricks`:
<Image
src={SearchFormbricks}
alt="Search Formbricks"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
Choose the event to trigger the Scenario:
<Image
src={SelectTriggers}
alt="Select Triggers"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
## Step 3: Connect Formbricks with Make
Click "Create a webhook":
<Image
src={CreateWebhook}
alt="Create Webhook"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
Enter the Formbricks API key. Learn how to get one from the [API Key tutorial](/docs/api/api-key-setup).
<Image src={EnterApiKey} alt="Enter API Key" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
## Step 4: Select Survey
Choose from your created surveys:
<Image src={SelectSurvey} alt="Select Survey" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
## Step 5: Send a test response
You need a test response for Make setup. For local Formbricks setup, use the [Demo App](/docs/contributing/demo) to submit a test response.
<Image
src={SubmitTestResponse}
alt="Submit Test Response"
quality="100"
className="rounded-lg max-w-full sm:max-w-3xl"
/>
## Step 6: Set up Google Sheet
Decide on the desired action for the data. Here, we'll send submissions to a Google Sheet:
<Image src={AddModule} alt="Add Module" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Choose "Add a Row" for the action:
<Image src={SelectAction} alt="Select Action" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Specify the spreadsheet details and match the Formbricks data:
<Image src={SelectFields} alt="Select Fields" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
A new row gets added to the spreadsheet for every response:
<Image src={Result} alt="Result" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

View File

@@ -19,8 +19,8 @@ import SuccessConnection from "./success-connection.png";
import UpdateQuestionId from "./update-question-id.png";
export const meta = {
title: "n8n Setup",
description: "Wire up Formbricks with n8n and 350+ other apps",
title: "Comprehensive Guide to Integrating Formbricks with n8n",
description: "Unlock the potential of combining Formbricks with n8n for a streamlined workflow experience. Dive into our step-by-step guide and send your survey data effortlessly to 350+ applications. Streamline your data processes now!",
};
#### Integrations
@@ -30,7 +30,7 @@ export const meta = {
n8n allows you to build flexible workflows focused on deep data integration. And with sharable templates and a user-friendly UI, the less technical people on your team can collaborate on them too. Unlike other tools, complexity is not a limitation. So you can build whatever you want — without stressing over budget. Hook up Formbricks with n8n and you can send your data to 350+ other apps. Here is how to do it.
<Note>
### Nail down your survey first {{ class: "text-white" }}
### Nail down your survey first
Any changes in the survey cause additional work in the n8n node. It makes sense to first settle on the survey
you want to run and then get to setting up n8n.
</Note>
@@ -39,12 +39,12 @@ n8n allows you to build flexible workflows focused on deep data integration. And
When setting up the node your life will be easier when you change the `questionId`s of your survey questions. You can only do so **before** you publish your survey.
<Image src={UpdateQuestionId} alt="Update Question ID" quality="100" className="rounded-lg" />
<Image src={UpdateQuestionId} alt="Update Question ID" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
_In every question card in the Advanced Settings you find the Question ID field. Update it so that you'll recognize the response tied to this question._
<Note>
### Already published? Duplicate survey {{ class: "text-white" }}
### Already published? Duplicate survey
You can only update the questionId when the survey was not yet published. Already published it? Just **duplicate
it** to update the questionIds.
<Image
@@ -59,29 +59,29 @@ _In every question card in the Advanced Settings you find the Question ID field.
Go to [n8n.io](https://n8n.io) and create a new workflow. Search for “Formbricks” to get started:
<Image src={AddFormbricksTrigger} alt="Add Formbricks Trigger" quality="100" className="rounded-lg" />
<Image src={AddFormbricksTrigger} alt="Add Formbricks Trigger" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
## Step 3: Connect Formbricks with n8n
Now, you have to connect n8n with Formbricks via an API Key:
<Image src={CreateNewCredentialBtn} alt="Create new credential button" quality="100" className="rounded-lg" />
<Image src={CreateNewCredentialBtn} alt="Create new credential button" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Click on Create New Credentail button to add your host and API Key
<Image src={AddApiKey} alt="Add host and api key" quality="100" className="rounded-lg" />
<Image src={AddApiKey} alt="Add host and api key" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Now you need an API key. Please refer to the [API Key Setup](/docs/api/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.
<Image src={SuccessConnection} alt="Successful Connection" quality="100" className="rounded-lg" />
<Image src={SuccessConnection} alt="Successful Connection" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
## Step 4: Select Event
Next, you can choose the event you want to trigger the node on. You can select multiple events:
<Image src={SelectEvent} alt="Select Event" quality="100" className="rounded-lg" />
<Image src={SelectEvent} alt="Select Event" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Here, we are adding `Response Finished` as an event, which will trigger when the survey has been filled out.
@@ -89,25 +89,25 @@ Here, we are adding `Response Finished` as an event, which will trigger when the
Next, you can choose from all the surveys you have created in this environment. You can select multiple surveys:
<Image src={SelectSurvey} alt="Select Survey" quality="100" className="rounded-lg" />
<Image src={SelectSurvey} alt="Select Survey" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Here, we are selecting two surveys.
<Image src={SelectedSurveys} alt="Selected Surveys" quality="100" className="rounded-lg" />
<Image src={SelectedSurveys} alt="Selected Surveys" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
## Step 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 in-app survey, you can use our [Demo App](/docs/contributing/demo) to trigger a survey and submit a response.
<Image src={SubmitTestResponse} alt="Submit Test Response" quality="100" className="rounded-lg" />
<Image src={SubmitTestResponse} alt="Submit Test Response" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Next, click on Listen for event button.
<Image src={ListenForEvent} alt="Listen for event" quality="100" className="rounded-lg" />
<Image src={ListenForEvent} alt="Listen for event" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
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.
<Image src={TestResponseSuccess} alt="Test Response Success" quality="100" className="rounded-lg" />
<Image src={TestResponseSuccess} alt="Test Response Success" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
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:
@@ -115,12 +115,12 @@ Now you have all the data you need at hand. The next steps depend on what you wa
Click on the plus and search `Discord`.
<Image src={AddDiscord} alt="Add Discord" quality="100" className="rounded-lg" />
<Image src={AddDiscord} alt="Add Discord" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
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.
<Image src={FillDiscordDetails} alt="Fill Discord Details" quality="100" className="rounded-lg" />
<Image src={FillDiscordDetails} alt="Fill Discord Details" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />
Once the execution is successful, you'll receive the content in the discord channel.
<Image src={DiscordResponse} alt="Discord Response" quality="100" className="rounded-lg" />
<Image src={DiscordResponse} alt="Discord Response" quality="100" className="rounded-lg max-w-full sm:max-w-3xl" />

View File

@@ -15,8 +15,8 @@ import UpdateQuestionId from "./update-question-id.webp";
import ZapierMessage from "./zapier-message.webp";
export const meta = {
title: "Zapier Setup",
description: "Wire up Formbricks with Zapier and 5000+ other apps",
title: "Step-by-Step Guide to Integrating Formbricks with Zapier",
description: "Master the integration of Formbricks with Zapier using our detailed guide. Seamlessly connect your surveys to 5000+ apps, automate data transfers, and enhance feedback management. Start optimizing your workflow today.",
};
#### Integrations

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "How Formbricks works",
title: "Inside Look: Formbricks In-Product Micro-Surveys",
description:
"Master in-product micro-surveys with Formbricks: user-friendly form builder, precise targeting, seamless integration, and insightful analytics for SaaS products.",
"Unlock the full potential of Formbricks: From intuitive form-building and event-based triggers to effortless integrations and deep analytics. Master the art of in-product surveys for your SaaS or digital platform.",
};
#### Introduction

View File

@@ -1,12 +1,12 @@
import { GettingStarted } from "@/components/docs/GettingStarted";
import { BestPractices } from "@/components/docs/BestPractices";
import BestPractices from "@/components/docs/BestPractices";
import { HeroPattern } from "@/components/docs/HeroPattern";
import { Button } from "@/components/docs/Button";
export const metadata = {
title: "Formbricks Open Source Experience Management",
title: "Formbricks: Privacy-first Experience Management",
description:
"Natively embed qualitative user research into your B2B SaaS. Leverage Best Practices for user discovery to increase Product-Market Fit",
"Enhance your product with Formbricks the leading open-source solution for in-product micro-surveys. Dive deep into user research, amplify product-market fit, and uncover the 'why' behind your analytics.",
};
export const sections = [
@@ -20,7 +20,7 @@ export const sections = [
Welcome to Formbricks, your go-to solution for in-product micro-surveys that will supercharge your product experience! 🚀 {{ className: 'lead' }}
<div className="not-prose mb-16 mt-6 flex gap-3">
<div className="mb-16 mt-6 flex gap-3">
<Button href="/docs/getting-started/quickstart-in-app-survey" arrow="right" children="Quickstart" />
</div>
@@ -34,7 +34,7 @@ Natively embed qualitative user research into your B2B SaaS. Leverage Best Pract
- 🧪 **Smart triggering**: Show the right survey at the right time with event-based triggers for accurate research and well-defined priorities.
- 🎉 **Open-source and self-hosted**: Enjoy full control over your data and infrastructure with our AGPL-licensed solution, and stay tuned for our upcoming cloud version!
<div className="not-prose">
<div>
<Button
href="https://app.formbricks.com/"
variant="text"
@@ -45,5 +45,3 @@ Natively embed qualitative user research into your B2B SaaS. Leverage Best Pract
</div>
<GettingStarted />
<BestPractices />

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Why is Formbricks better?",
title: "Formbricks vs. Generic Survey Tools: A Comparative Insight",
description:
"The ultimate survey solution for SaaS, offering in-depth micro-surveys, precise targeting, and seamless integrations. Discover the difference today!",
"Discover how Formbricks excels as a specialized in-product micro-survey platform for SaaS. Get unmatched targeting, seamless integrations, and make informed decisions with our open-source advantage.",
};
#### Introduction

View File

@@ -3,8 +3,8 @@ import Image from "next/image";
import QuestionId from "./question-id.webp";
export const meta = {
title: "Data Prefilling in Link Surveys",
description: "Prefill data in your surveys to make it easier for your users to provide feedback.",
title: "URL Data Prefilling for Link Surveys in Formbricks",
description: "Master the art of data prefilling in Formbricks link surveys. Dive into our guide on how to use URL parameters to prepopulate answers, boosting conversion rates and enhancing user experience. Learn through examples and ensure correct validation for each question type.",
};
#### Link Surveys
@@ -22,7 +22,7 @@ URL prefilling of data comes in handy when you:
- Want to embed the first question in an email and increase conversion by prefilling the choice
## Quick Example
<Col>
<CodeGroup title="Example URL">
```sh
@@ -30,7 +30,7 @@ https://app.formbricks.com/s/clin3dxja02k8l80hpwmx4bjy?question_id=5
```
</CodeGroup>
</Col>
## How it works
To prefill the first question of a survey, append `?question_id=answer` at the end of the survey URL. The answer has to match the expected type of the question. For example, if the first question is a rating question, the answer has to be a number. If the first question is a single select question, the answer has to be a string.
@@ -58,7 +58,7 @@ You find the `questionId` in the Advanced Settings at the bottom of each questio
Here are a few examples to get you started:
### Rating Question
<Col>
<CodeGroup title="Translates to 5 stars / points / emojis">
```sh
@@ -66,9 +66,9 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?rating_question_id=5
```
</CodeGroup>
</Col>
### NPS Question
<Col>
<CodeGroup title="Translates to an NPS rating of 10">
```sh
@@ -76,9 +76,9 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?nps_question_id=10
```
</CodeGroup>
</Col>
### Single Select Question (Radio)
<Col>
<CodeGroup title="Chooses the option 'Very disappointed' in the single select question. The string has to be identical to the option in your question">
```sh
@@ -86,9 +86,9 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?single_select_question_id
```
</CodeGroup>
</Col>
### Multi Select Question (Checkbox)
<Col>
<CodeGroup title="Selects three options 'Sun, Palms and Beach' in the multi select question. The strings have to be identical to the options in your question">
```sh
@@ -96,9 +96,9 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?multi_select_question_id=
```
</CodeGroup>
</Col>
### Open Text Question
<Col>
<CodeGroup title="Adds 'I love Formbricks' as the answer to the open text question">
```sh
@@ -106,9 +106,9 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?openText_question_id=I%20
```
</CodeGroup>
</Col>
### CTA Question
<Col>
<CodeGroup title="Adds 'clicked' as the answer to the CTA question. Alternatively, you can set it to 'dismissed' to skip the question.">
```txt
@@ -116,7 +116,7 @@ https://app.formbricks.com/s/clin3yxja52k8l80hpwmx4bjy?cta_question_id=clicked
```
</CodeGroup>
</Col>
## Validation
Make sure that the answer in the URL matches the expected type for the first question.

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1,80 @@
import Image from "next/image";
import EnvVar from "./env-variable.webp";
import ShareModal from "./share-modal.webp";
import Settings from "./single-use-setting.webp";
import Message from "./used-message.webp";
import Metadata from "./metadata.webp";
export const meta = {
title: "Single Use Links",
description: "Make sure that each respondent only replies once with single use links.",
};
#### Link Surveys
# Single Use Links
This guide will help you understand how to generate and use single-use links within our application.
## Purpose
- Single-use links (or one-time / disposable links) are URLs that grant access to a survey only once.
- The primary purpose of single-use links is to assure that no respondent submits a survey twice.
## Using Single-Use Links with Formbricks
Using single-use links with Formbricks is quite straight-forward:
1. In the survey settings, toggle "Single Use Link" on:
<Image
src={Settings}
alt="Single use survey settings"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
2. When you publish your survey, the following modal will open:
<Image
src={ShareModal}
alt="Share modal with 7 single use links which can be regenerated"
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
Here, you can copy and generate as many single-use links as you need.
## URL Encryption
You can encrypt single use URLs to assure information to be protected. To enable it, you have to set the correct environment variable:
<Image
src={EnvVar}
alt="Set the right env var to be able to enable encryption."
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
## Check suId of a submission
You can find the suId of each submission in the submission meta data. To view it, simplte hover over the Avatar:
<Image
src={Metadata}
alt="View suId in the submission meta data."
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>
### 'Link used' message
You can customize the 'link used' messaging in the Survey Editor settings:
<Image
src={Message}
alt="Adjust the message shown to people if a link was already used."
quality="100"
className="max-w-full rounded-lg sm:max-w-3xl"
/>

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

View File

@@ -3,9 +3,9 @@ import Image from "next/image";
import PeopleView from "./people-view.webp";
export const meta = {
title: "User Identification in Link Surveys",
title: "Effective User Identification in Formbricks Link Surveys",
description:
"Identify users in link surveys via URL parameter. Connect responses to existing users in Formbricks.",
"Discover how to seamlessly connect responses from Formbricks link surveys to existing users in your database. Learn the intricacies of the userId URL parameter to enhance user tracking, profiling, and segmentation, ensuring more personalized interactions and data-driven decisions.",
};
#### Link Surveys
@@ -23,7 +23,7 @@ Identifying users in link surveys comes in handy when you:
- Want to gather data and later connect it to a user who has not signed up yet
## Quick Example
<Col>
<CodeGroup title="User Identification Example">
```txt
@@ -31,7 +31,7 @@ https://app.formbricks.com/s/clin3dxja02k8l80hpwmx4bjy?userId=ABC123
```
</CodeGroup>
</Col>
## How it works
To link a response to a user in your Formbricks database, you can pass your internal user Id as a URL parameter.
@@ -42,16 +42,6 @@ The `userId` we are refering to is the `userId` of your own system. For example,
This allows you to connect the response to the user profile of this specific in the Formbricks database. You can then use the response data to create segments for further surveying or invite them to an interview, etc.
## getOrCreateUser - how it works exactly
By default, respondents of link surveys are **not** recorded and displayed in the People view. This would lead to your People view to be spammend with unidentified people.
If you add the `userId` URL parameter a Person will be created, if there is no existing person in your database with a matching `userId`.
**Case 1:** User with userId `ABC111` exists, the response from the link survey will be added to this users profile.
**Case 2:** User with userId `ABC222` does not yet exists, so it is created with the response from the link survey connected to this user.
<Image
src={PeopleView}
alt="If users are identified by email, it will show. If not, the internal Id will be set."

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Deploying Formbricks to production",
title: "Comprehensive Guide to Self-Hosting Formbricks",
description:
"Utilize Docker-Compose for easy deployment on your machine. Clone the repo, configure settings, and build the image to access the app on localhost.",
"Discover versatile options to deploy Formbricks tailored to your expertise level. From Ubuntu setups using shell scripts, swift Docker deployments, to manual source configurations, harness the flexibility and power of Formbricks to fit your unique hosting needs. Dive in today!",
};
#### Self-Hosting

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Deploying Formbricks with Docker",
title: "Guide to Deploying Formbricks Using Docker",
description:
"Utilize Docker-Compose for easy deployment on your machine. Clone the repo, configure settings, and build the image to access the app on localhost.",
"Step-by-step tutorial on how to effortlessly set up and run Formbricks via Docker. Explore the quick deployment process with Docker-Compose, learn how to update Formbricks, and troubleshoot common issues. Ideal for those looking for a hassle-free Formbricks experience",
};
#### Self-Hosting
@@ -24,7 +24,7 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
1. **Create a New Directory for Formbricks**
Open a terminal and create a new directory for Formbricks, then navigate into this new directory:
<Col>
<CodeGroup title="Create and cd into the new directory">
```bash
@@ -32,11 +32,11 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
</Col>
2. **Download the Docker-Compose File**
Download the docker-compose file directly from the Formbricks repository:
<Col>
<CodeGroup title="Download docker compose file">
```bash
@@ -44,11 +44,11 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
</Col>
3. **Generate NextAuth Secret**
Next, you need to generate a NextAuth secret. This will be used for session signing and encryption. The `sed` command below generates a random string using `openssl`, then replaces the `NEXTAUTH_SECRET:` placeholder in the `docker-compose.yml` file with this generated secret:
<Col>
<CodeGroup title="Generate NextAuth Secret">
```bash
@@ -56,19 +56,21 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
</Col>
4. **Start the Docker Setup**
You're now ready to start the Formbricks Docker setup. The following command will start Formbricks together with a postgreSQL database using Docker Compose:
We pass the `--env-file /dev/null` flag to docker-compose to prevent it from reading the .env file. This is because we're using environment variables directly in the docker-compose.yml file as the env file is currently in a format not well recognised by docker systems.
<Col>
<CodeGroup title="Launch Docker Instance">
```bash
docker compose up -d
docker compose --env-file /dev/null up -d
```
</CodeGroup>
</Col>
The `-d` flag will run the containers in detached mode, meaning they'll run in the background.
5. **Visit Formbricks in Your Browser**
@@ -78,7 +80,7 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
## Updating Formbricks
1. Stop the Formbricks stack
<Col>
<CodeGroup title="Stop the docker instance">
```bash
@@ -86,9 +88,9 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
</Col>
2. Pull the latest changes
<Col>
<CodeGroup title="Pull the changes into docker">
```bash
@@ -96,22 +98,22 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
</Col>
3. Update env vars as necessary in the docker-compose file.
4. Re-start the Formbricks stack
<Col>
<CodeGroup title="Relaunch the Docker Instance">
```bash
docker compose up -d
docker compose --env-file /dev/null up -d
```
</CodeGroup>
</Col>
## Debugging
If you encounter any issues, you can check the logs of the container with:
<Col>
<CodeGroup title="Look into docker logs">
```bash
@@ -119,9 +121,9 @@ docker compose logs -f
```
</CodeGroup>
</Col>
In an ideal case, you should see something like this:
<Col>
<CodeGroup title="Docker Build Underway">
```bash
@@ -149,9 +151,9 @@ In an ideal case, you should see something like this:
```
</CodeGroup>
</Col>
And at the tail of the output, you should see something like this:
<Col>
<CodeGroup title="Docker Build Completed">
```bash
@@ -162,7 +164,7 @@ formbricks-quickstart-formbricks-1 | Listening on port 3000 url: http://<random
```
</CodeGroup>
</Col>
You can close the logs again with `CTRL + C`.
<Note>

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Deploying Formbricks from Source Code",
title: "Formbricks Self-Hosting Guide: Deploy from Source Code for Complete Customization",
description:
"Build the Formbricks Image right from the open-sourced codebase and make changes however needed. Deploy it then with the freedom of customizing even the compile-time environment variables.",
"Build the Formbricks Image right from the open-sourced codebase and make changes however needed. Deploy it then with the freedom of customizing even the compile-time environment variables. Gain more control and flexibility by customizing compile-time environment variables and configuring your instance. Dive into our comprehensive guide for building and running Formbricks with Docker.",
};
#### Self-Hosting
@@ -20,7 +20,7 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
</Note>
1. **Clone the repository**:
<Col>
<CodeGroup title="Clone and cd into the Formbricks directory">
```bash
@@ -28,8 +28,8 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
```
</CodeGroup>
2. **Modify the `.env.docker` file as required by your setup.** <br/> This file comes with a basic setup and Formbricks works without making any changes to the file. To enable email sending functionality you need to configure the SMTP settings. If you configured your email credentials, you can also comment the following lines to enable email verification (`# NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED=1`) and password reset (`# NEXT_PUBLIC_PASSWORD_RESET_DISABLED=1`)
</Col>
2. **Modify the environment variables in your `docker-compose.yml` file as required by your setup.** <br/> This file comes with a basic setup and Formbricks works without making any changes to the file. To enable email sending functionality you need to configure the SMTP settings. If you configured your email credentials, you can also comment the following lines to enable email verification (`# NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED=1`) and password reset (`# NEXT_PUBLIC_PASSWORD_RESET_DISABLED=1`)
<Note>
## Editing a NEXT_PUBLIC_* variable?
@@ -38,60 +38,94 @@ Ensure `docker` & `docker compose` are installed on your server/system. Both are
to take effect.
</Note>
3. **Start the docker compose process.** <br/> Finally start the docker compose process to build and spin up the Formbricks container as well as the PostgreSQL database. <br/> _Use docker-compose if you are on an older docker version_
3. **Generate NextAuth Secret**
Next, you need to generate a NextAuth secret. This will be used for session signing and encryption. The `sed` command below generates a random string using `openssl`, then replaces the `NEXTAUTH_SECRET:` placeholder in the `docker-compose.yml` file with this generated secret:
<Col>
<CodeGroup title="Generate NextAuth Secret">
```bash
sed -i "/x-nextauth-secret: &nextauth_secret/s/RANDOM_STRING/$(openssl rand -base64 32 | tr -dc 'a-zA-Z0-9' | head -c 32)/" docker-compose.yml
```
</CodeGroup>
</Col>
4. **Start the docker compose process.** <br/> Finally start the docker compose process to build and spin up the Formbricks container as well as the PostgreSQL database. <br/> _Use docker-compose if you are on an older docker version_
We pass the `--env-file /dev/null` flag to docker-compose to prevent it from reading the .env file. This is because we're using environment variables directly in the docker-compose.yml file as the env file is currently in a format not well recognised by docker systems.
<Col>
<CodeGroup title="Launch docker instances">
```bash
docker compose up -d
docker compose --env-file /dev/null up
```
</CodeGroup>
</Col>
You can now access the app on [http://localhost:3000](http://localhost:3000). You will be automatically redirected to the login. To use your local installation of Formbricks, create a new account.
### Important Run-time Variables
## Important Run-time Variables
These variables must also be provided at runtime.
| Variable | Description | Required | Default |
| --------------- | --------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------- |
| WEBAPP_URL | Base URL of the site. | required | `http://localhost:3000` |
| DATABASE_URL | Database URL with credentials. | required | `postgresql://postgres:postgres@postgres:5432/formbricks?schema=public` |
| NEXTAUTH_SECRET | Secret for NextAuth, used for session signing and encryption. | required | (Generated by the user) |
| NEXTAUTH_URL | Location of the auth server. By default, this is the Formbricks docker instance itself. | required | `http://localhost:3000` |
| Variable | Description | Required | Default |
| --------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------- |
| WEBAPP_URL | Base URL of the site. | required | `http://localhost:3000` |
| SURVEY_BASE_URL | Base URL of the link surveys. | required | `http://localhost:3000/s/` |
| DATABASE_URL | Database URL with credentials. | required | `postgresql://postgres:postgres@postgres:5432/formbricks?schema=public` |
| NEXTAUTH_SECRET | Secret for NextAuth, used for session signing and encryption. | required | (Generated by the user) |
| NEXTAUTH_URL | Location of the auth server. By default, this is the Formbricks docker instance itself. | required | `http://localhost:3000` |
| PRIVACY_URL | URL for privacy policy. | optional | |
| TERMS_URL | URL for terms of service. | optional | |
| IMPRINT_URL | URL for imprint. | optional | |
| SIGNUP_DISABLED | Disables the ability for new users to create an account if set to `1`. | optional | |
| PASSWORD_RESET_DISABLED | Disables password reset functionality if set to `1`. | optional | |
| EMAIL_VERIFICATION_DISABLED | Disables email verification if set to `1`. | optional | |
| INVITE_DISABLED | Disables the ability for invited users to create an account if set to `1`. | optional | |
| MAIL_FROM | Email address to send emails from. | optional (required if email services are to be enabled) | |
| SMTP_HOST | Host URL of your SMTP server. | optional (required if email services are to be enabled) | |
| SMTP_PORT | Host Port of your SMTP server. | optional (required if email services are to be enabled) | |
| SMTP_USER | Username for your SMTP Server. | optional (required if email services are to be enabled) | |
| SMTP_PASSWORD | Password for your SMTP Server. | optional (required if email services are to be enabled) | |
| SMTP_SECURE_ENABLED | SMTP secure connection. For using TLS, set to `1` else to `0`. | optional (required if email services are to be enabled) | |
| GITHUB_AUTH_ENABLED | Enables GitHub login if set to `1`. | optional | |
| GOOGLE_AUTH_ENABLED | Enables Google login if set to `1`. | optional | |
| GITHUB_ID | Client ID for GitHub. | optional (required if GitHub auth is enabled) | |
| GITHUB_SECRET | Secret for GitHub. | optional (required if GitHub auth is enabled) | |
| GOOGLE_CLIENT_ID | Client ID for Google. | optional (required if Google auth is enabled) | |
| GOOGLE_CLIENT_SECRET | Secret for Google. | optional (required if Google auth is enabled) | |
| CRON_SECRET | API Secret for running cron jobs. | optional | |
| STRIPE_SECRET_KEY | Secret key for Stripe integration. | optional | |
| STRIPE_WEBHOOK_SECRET | Webhook secret for Stripe integration. | optional | |
| TELEMETRY_DISABLED | Disables telemetry if set to `1`. | optional | |
| INSTANCE_ID | Instance ID for Formbricks Cloud to be sent to Telemetry. | optional | |
| INTERNAL_SECRET | Internal Secret (Currently we overwrite the value with a random value). | optional | |
| IS_FORMBRICKS_CLOUD | Uses Formbricks Cloud if set to `1` | optional | |
| DEFAULT_BRAND_COLOR | Default brand color for your app (Can be overwritten from the UI as well). | optional | `#64748b` |
### Build-time Variables
## Build-time Variables
These variables must be provided at the time of the docker build and can be provided by updating the `.env` file.
| Variable | Description | Required | Default |
| --------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------- | ----------------------- |
| NEXT_PUBLIC_WEBAPP_URL | Base URL injected into static files. | required | `http://localhost:3000` |
| PRISMA_GENERATE_DATAPROXY | Enables a dedicated connection pool for Prisma using Prisma Data Proxy. Uncomment to enable. | optional | |
| NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED | Disables email verification if set to `1`. | optional | |
| NEXT_PUBLIC_PASSWORD_RESET_DISABLED | Disables password reset functionality if set to `1`. | optional | |
| NEXT_PUBLIC_SIGNUP_DISABLED | Disables the ability for new users to create an account if set to `1`. | optional | |
| NEXT_PUBLIC_INVITE_DISABLED | Disables the ability for invited users to create an account if set to `1`. | optional | |
| NEXT_PUBLIC_PRIVACY_URL | URL for privacy policy. | optional | |
| NEXT_PUBLIC_TERMS_URL | URL for terms of service. | optional | |
| NEXT_PUBLIC_IMPRINT_URL | URL for imprint. | optional | |
| SENTRY_IGNORE_API_RESOLUTION_ERROR | Disables Sentry warning if set to `1`. | optional | |
| NEXT_PUBLIC_SENTRY_DSN | DSN for Sentry error tracking. | optional | |
| NEXT_PUBLIC_GITHUB_AUTH_ENABLED | Enables GitHub login if set to `1`. | optional | |
| GITHUB_ID | Client ID for GitHub. | optional (required if GitHub auth is enabled) | |
| GITHUB_SECRET | Secret for GitHub. | optional (required if GitHub auth is enabled) | |
| NEXT_PUBLIC_GOOGLE_AUTH_ENABLED | Enables Google login if set to `1`. | optional | |
| GOOGLE_CLIENT_ID | Client ID for Google. | optional (required if Google auth is enabled) | |
| GOOGLE_CLIENT_SECRET | Secret for Google. | optional (required if Google auth is enabled) | |
| CRON_SECRET | Secret for running cron jobs. | optional | |
Please refer to the [Formbricks Instructions](https://github.com/formbricks/formbricks) for more details on generating these variables.
| Variable | Description | Required | Default |
| -------------------------------------------------- | --------------------------------------------------------------- | -------- | ------- |
| NEXT_PUBLIC_FORMBRICKS_API_HOST | Host for the Formbricks API. | optional | |
| NEXT_PUBLIC_FORMBRICKS_ENVIRONMENT_ID | If you already have a preset environment ID of the environment. | optional | |
| NEXT_PUBLIC_FORMBRICKS_ONBOARDING_SURVEY_ID | If you already have an onboarding survey ID to show new users. | optional | |
| NEXT_PUBLIC_POSTHOG_API_KEY | API key for PostHog analytics. | optional | |
| NEXT_PUBLIC_POSTHOG_API_HOST | Host for PostHog analytics. | optional | |
| NEXT_PUBLIC_SENTRY_DSN | DSN for Sentry error tracking. | optional | |
| NEXT_PUBLIC_DOCSEARCH_APP_ID | ID of the DocSearch application. | optional | |
| NEXT_PUBLIC_DOCSEARCH_API_KEY | API key of the DocSearch application. | optional | |
| NEXT_PUBLIC_DOCSEARCH_INDEX_NAME | Name of the DocSearch index. | optional | |
| NEXT_PUBLIC_FORMBRICKS_COM_ENVIRONMENT_ID | Environment ID for Formbricks (if you already have one) | optional | |
| NEXT_PUBLIC_FORMBRICKS_COM_DOCS_FEEDBACK_SURVEY_ID | Survey ID for the feedback survey on the docs site. | optional | |
| NEXT_PUBLIC_FORMBRICKS_COM_API_HOST | Host for the Formbricks API. | optional | |
## Debugging
If you encounter any issues, you can check the logs of the container with:
<Col>
<CodeGroup title="Docker container logs">
```bash
@@ -99,7 +133,7 @@ docker compose logs -f
```
</CodeGroup>
</Col>
You can close the logs again with `CTRL + C`.
Still facing issues? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!

View File

@@ -0,0 +1,132 @@
export const meta = {
title: "Migrating Formbricks to v1.1",
description:
"Formbricks v1.1 comes with an amazing set of features including the ability to define most environment variables at runtime itself! No need to build the image again! This guide will help you migrate your existing Formbricks instance to v1.1",
};
#### Self-Hosting
# Migrating to v1.1
Formbricks v1.1 includes a lot of new features and improvements. However, it also comes with a few breaking changes specifically with the environment variables. This guide will help you migrate your existing Formbricks instance to v1.1 without losing any data.
## Changes in .env
### Renamed Environment Variables
This was introduced because we got a lot of requests from our users for the ability to define some common environment variables at runtime itself i.e. without having to rebuild the image for the changes to take effect.
This is now possible with v1.1. However, due to Next.JS best practices, we had to deprecate the prefix **NEXT_PUBLIC_** in the following environment variables:
| till v1.0 | v1.1 |
| ------------------------------------------- | --------------------------- |
| **NEXT_PUBLIC_**EMAIL_VERIFICATION_DISABLED | EMAIL_VERIFICATION_DISABLED |
| **NEXT_PUBLIC_**PASSWORD_RESET_DISABLED | PASSWORD_RESET_DISABLED |
| **NEXT_PUBLIC_**SIGNUP_DISABLED | SIGNUP_DISABLED |
| **NEXT_PUBLIC_**INVITE_DISABLED | INVITE_DISABLED |
| **NEXT_PUBLIC_**PRIVACY_URL | PRIVACY_URL |
| **NEXT_PUBLIC_**TERMS_URL | TERMS_URL |
| **NEXT_PUBLIC_**IMPRINT_URL | IMPRINT_URL |
| **NEXT_PUBLIC_**GITHUB_AUTH_ENABLED | GITHUB_AUTH_ENABLED |
| **NEXT_PUBLIC_**GOOGLE_AUTH_ENABLED | GOOGLE_AUTH_ENABLED |
| **NEXT_PUBLIC_**WEBAPP_URL | WEBAPP_URL |
| **NEXT_PUBLIC_**IS_FORMBRICKS_CLOUD | IS_FORMBRICKS_CLOUD |
| **NEXT_PUBLIC_**SURVEY_BASE_URL | SURVEY_BASE_URL |
<Note>
Please note that their values and the logic remains exactly the same. Only the prefix has been deprecated. The other environment variables remain the same as well.
</Note>
### Deprecated Environment Variables
- **NEXT_PUBLIC_VERCEL_URL**: Was used as Vercel URL (used instead of WEBAPP_URL), but from v1.1, you can just set the WEBAPP_URL environment variable to your Vercel URL.
- **RAILWAY_STATIC_URL**: Was used as Railway Static URL (used instead of WEBAPP_URL), but from v1.1, you can just set the WEBAPP_URL environment variable.
- **RENDER_EXTERNAL_URL**: Was used as an external URL to Render (used instead of WEBAPP_URL), but from v1.1, you can just set the WEBAPP_URL environment variable.
- **HEROKU_APP_NAME**: Was used to build the App name on a Heroku hosted webapp, but from v1.1, you can just set the WEBAPP_URL environment variable.
- **NEXT_PUBLIC_WEBAPP_URL**: Was used for the same purpose as WEBAPP_URL, but from v1.1, you can just set the WEBAPP_URL environment variable.
- **PRISMA_GENERATE_DATAPROXY**: Was used to tell Prisma that it should generate the runtime for Dataproxy usage. But its officially deprecated now.
## Helper Shell Script
For a seamless migration, below is a shell script for your self-hosted instance that will automatically update your environment variables to be compliant with the new naming conventions.
### Building From Source
The below script will:
1. Create a backup of your existing .env file as `.env.old`
2. Update the .env file to be compliant with the new naming conventions
<Col>
<CodeGroup title="Run the below in your terminal in the directory of your .env">
```shell {{ title: '.env file' }}
for var in NEXT_PUBLIC_EMAIL_VERIFICATION_DISABLED NEXT_PUBLIC_PASSWORD_RESET_DISABLED NEXT_PUBLIC_SIGNUP_DISABLED NEXT_PUBLIC_INVITE_DISABLED NEXT_PUBLIC_PRIVACY_URL NEXT_PUBLIC_TERMS_URL NEXT_PUBLIC_IMPRINT_URL NEXT_PUBLIC_GITHUB_AUTH_ENABLED NEXT_PUBLIC_GOOGLE_AUTH_ENABLED NEXT_PUBLIC_WEBAPP_URL NEXT_PUBLIC_IS_FORMBRICKS_CLOUD NEXT_PUBLIC_SURVEY_BASE_URL; do sed -i.old "s/^$var=/$(echo $var | sed 's/NEXT_PUBLIC_//')=/" .env; done; echo "Formbricks environment variables have been migrated as per v1.1! You are good to go."
```
</CodeGroup>
</Col>
### Docker & Single Script Setup
Now that these variables can be defined at runtime, you can append them inside your `x-environment` in the `docker-compose.yml` itself.
For a more detailed guide on these environment variables, please refer to the [Important Runtime Variables](/docs/self-hosting/from-source#important-run-time-variables) section.
<Col>
<CodeGroup title="docker-compose.yml">
```yaml {{ title: 'docker-compose.yml' }}
version: "3.3"
x-environment: &environment
environment:
# The url of your Formbricks instance used in the admin panel
WEBAPP_URL:
# PostgreSQL DB for Formbricks to connect to
DATABASE_URL: "postgresql://postgres:postgres@postgres:5432/formbricks?schema=public"
# NextJS Auth
# @see: https://next-auth.js.org/configuration/options#nextauth_secret
# You can use: `openssl rand -base64 32` to generate one
NEXTAUTH_SECRET:
# Set this to your public-facing URL, e.g., https://example.com
# You do not need the NEXTAUTH_URL environment variable in Vercel.
NEXTAUTH_URL: http://localhost:3000
# PostgreSQL password
POSTGRES_PASSWORD: postgres
# Email Configuration
MAIL_FROM:
SMTP_HOST:
SMTP_PORT:
SMTP_SECURE_ENABLED:
SMTP_USER:
SMTP_PASSWORD:
# Uncomment the below and set it to 1 to disable Email Verification for new signups
# EMAIL_VERIFICATION_DISABLED:
# Uncomment the below and set it to 1 to disable Password Reset
# PASSWORD_RESET_DISABLED:
# Uncomment the below and set it to 1 to disable Signups
# SIGNUP_DISABLED:
# Uncomment the below and set it to 1 to disable Invites
# INVITE_DISABLED:
# Uncomment the below and set a value to have your own Privacy Page URL on the signup & login page
# PRIVACY_URL:
# Uncomment the below and set a value to have your own Terms Page URL on the auth and the surveys page
# TERMS_URL:
# Uncomment the below and set a value to have your own Imprint Page URL on the auth and the surveys page
# IMPRINT_URL:
# Uncomment the below and set to 1 if you want to enable GitHub OAuth
# GITHUB_AUTH_ENABLED:
# GITHUB_ID:
# GITHUB_SECRET:
# Uncomment the below and set to 1 if you want to enable Google OAuth
# GOOGLE_AUTH_ENABLED:
# GOOGLE_CLIENT_ID:
# GOOGLE_CLIENT_SECRET:
```
</CodeGroup>
</Col>
Did we miss something? Are you still facing issues migrating your app? [Join our Discord!](https://formbricks.com/discord) We'd be happy to help!

View File

@@ -1,7 +1,7 @@
export const meta = {
title: "Deploying Formbricks to production",
title: "Step by Step Guide on Deploying Formbricks to Production on Ubuntu",
description:
"Utilize Docker-Compose for easy deployment on your machine. Clone the repo, configure settings, and build the image to access the app on localhost.",
"Master the swift deployment of Formbricks on an Ubuntu server with our step-by-step guide. Use a single command to automate Docker, Postgres DB, SSL certificate configuration, and more. Encounter issues? Dive into our troubleshooting steps or join our community on Discord for assistance.",
};
#### Self-Hosting
@@ -25,7 +25,7 @@ Before you proceed, make sure you have the following:
## Single Command Setup
Copy and paste the following command into your terminal:
<Col>
<CodeGroup title="Single Command to deploy Formbricks">
```bash
@@ -33,11 +33,11 @@ Copy and paste the following command into your terminal:
```
</CodeGroup>
</Col>
The script will prompt you for the following information:
1. **Overwriting Docker GPG Keys**: If Docker GPG keys already exist, the script will ask if you want to overwrite them.
<Col>
<CodeGroup title="Docker GPG Keys Overwrite Prompt">
```bash
@@ -53,9 +53,9 @@ The script will prompt you for the following information:
```
</CodeGroup>
</Col>
2. **Email Address**: Provide your email address for SSL certificate registration with Let's Encrypt.
<Col>
<CodeGroup title="Email Prompt">
```bash
@@ -80,9 +80,9 @@ The script will prompt you for the following information:
```
</CodeGroup>
</Col>
3. **Domain Name**: Enter the domain name that Traefik will use to create the SSL certificate and forward requests to Formbricks.
<Col>
<CodeGroup title="Domain Name for SSL certificate Prompt">
```bash
@@ -111,9 +111,9 @@ The script will prompt you for the following information:
```
</CodeGroup>
</Col>
**That's it**! After running the command and providing the required information, visit the domain name you entered, and you should see the Formbricks home wizard!
<Col>
<CodeGroup title="Successfully setup Formbricks on your Ubuntu machine">
```bash
@@ -153,11 +153,11 @@ my.hosted.url.com
```
</CodeGroup>
</Col>
## Debugging
If you encounter any issues, you can check the logs of the container with:
<Col>
<CodeGroup title="Check logs of the container">
```bash
@@ -165,7 +165,7 @@ cd formbricks && docker compose logs -f
```
</CodeGroup>
</Col>
You can close the logs again with `CTRL + C`.
<Note>

View File

@@ -151,7 +151,7 @@ function BestPractice({ resource }: { resource: BestPractice }) {
);
}
export function BestPractices() {
export default function BestPractices() {
return (
<div className="my-16 xl:max-w-none">
<Heading level={2} id="resources">

Some files were not shown because too many files have changed in this diff Show More