mirror/formbricks-formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2025-12-30 18:30:32 -06:00
Code Issues Packages Projects Releases 100 Wiki Activity

update docs page

Browse Source
This commit is contained in:
Johannes
2023-10-07 15:54:43 +05:45
parent c9fea202c4
commit 91caac94b6
1 changed files with 20 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
apps/formbricks-com/app/docs/link-surveys/single-use-links/page.mdx
View File

@@ -2,73 +2,41 @@
# Single Use Links
This guide will help you understand how to generate and use single-use links within our application.
This guide will help you understand how to generate and use single-use links within our application.
## Purpose
- Single-use links, also known as one-time links or disposable links, are URLs that grant access to a resource or perform an action only once.
- 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 enhance security and control over access to sensitive information or functionality.
- The primary purpose of single-use links is to assure that no respondent submits a survey twice.
## Using Single-Use Links with Formbricks
## How it works
Using single-use links with Formbricks is quite straight-forward:
Single-use links work based on the following principles:
1. In the survey settings, toggle "Single Use Link" on:
IMAGE
- Uniqueness: Each generated link is unique and can be used only once.
- Expiration: Links may have an expiration time after which they become invalid.
- Tracking: Usage of links can be tracked to monitor access.
- Security: Single-use links are more secure than static passwords or open-access URLs.
2. When you publish your survey, the following modal will open:
IMAGE 2
## Generating Single-Use Links
Here, you can copy and generate as many single-use links as you need.
To generate a single-use link, follow these steps:
## URL Encryption
- Authentication: Ensure that the user or system generating the link is authenticated and authorized to create single-use links.
URL encryption is a security measure that ensures the confidentiality and integrity of single-use links. In Formbricks, URL encryption is achieved using the corresponding environment variable. When constructing single-use links, the data, including the unique identifier, is encrypted before being added to the URL. This encryption mechanism helps protect sensitive information from being tampered with or intercepted during transmission.
- Create a Unique Identifier: Generate a unique identifier for the link, often in the form of a token or hash.
The environment variable you have to set is called:
- Set Expiration (Optional): If desired, set an expiration time for the link to control its validity.
## Where do I find the suId which was used for a specific response?
- Store Data (Optional): If the link is meant to grant access to specific data or functionality, ensure that data is properly associated with the link identifier.
You can find the suId of each submission in the submission meta data. To view it, simplte hover over the Avatar:
IMAGE AVATAR
- Generate the Link: Construct the URL with the unique identifier and any necessary parameters.
### What happens when a user tries to access a survey without a suId?
- Store and Protect: Store the generated link securely and ensure it's not exposed to unauthorized users.
### What happens when a link was already used?
## Using Single-Use Links
You can customize the 'link used' messaging in the Survey Editor settings:
To use a single-use link, follow these steps:
- Access the Link: Users or systems with valid single-use links can access the URL.
- Validation: The system validates the link's uniqueness, expiration, and any associated data.
- Perform Action: If the link is valid, it grants access to the intended resource or functionality.
- Logging: The system logs the usage of the link for auditing purposes.
## Security Considerations
When implementing single-use links, consider the following security best practices:
- Token Generation: Ensure that tokens or identifiers are truly unique and not guessable.
- Expiration: Set a reasonable expiration time to limit the window of opportunity for misuse.
- Encryption: Transmit and store links securely to prevent interception or exposure.
- Access Controls: Restrict access to link generation and usage to authorized entities.
- Logging and Auditing: Maintain logs of link usage for security audits.
## URL Encryption
URL encryption is a security measure that ensures the confidentiality and integrity of single-use links. In FormBricks, URL encryption is achieved using the corresponding environment variable. When constructing single-use links, the data, including the unique identifier, is encrypted before being added to the URL. This encryption mechanism helps protect sensitive information from being tampered with or intercepted during transmission.
## Location of "suID" (Single Use ID)
As of the current implementation, the "suID" (Single Use ID) is located next to the completed tag in FormBricks. This means that when a survey is completed using a single-use link, you can find the "suID" in close proximity to the completion status, making it easily identifiable and accessible for reference.
## Examples
IMAGE 3