docs: Added Single Use Links Section in Docs.

docs: Added Single Use Links Section in Docs.
This commit is contained in:
Johannes
2023-10-07 16:36:57 +05:45
committed by GitHub
7 changed files with 81 additions and 0 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

@@ -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

@@ -237,6 +237,7 @@ export const navigation: Array<NavGroup> = [
links: [
{ title: "Data Prefilling", href: "/docs/link-surveys/data-prefilling" },
{ title: "User Identification", href: "/docs/link-surveys/user-identification" },
{ title: "Single Use Links", href: "/docs/link-surveys/single-use-links" },
],
},
{