From 5c2860d1a413d71fa6a28e5046eb3eb41cd1529a Mon Sep 17 00:00:00 2001 From: Johannes <72809645+jobenjada@users.noreply.github.com> Date: Thu, 10 Jul 2025 00:13:29 -0700 Subject: [PATCH] docs: Personal Link docs (#6034) Co-authored-by: Dhruwang --- docs/mint.json | 7 +- .../surveys/link-surveys/personal-links.mdx | 121 ++++++++++++++++++ .../surveys/link-surveys/single-use-links.mdx | 4 +- .../advanced-targeting.mdx | 2 +- 4 files changed, 128 insertions(+), 6 deletions(-) create mode 100644 docs/xm-and-surveys/surveys/link-surveys/personal-links.mdx diff --git a/docs/mint.json b/docs/mint.json index 5d037e5c1c..0f500c3bb2 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -64,12 +64,13 @@ "pages": [ "xm-and-surveys/surveys/link-surveys/data-prefilling", "xm-and-surveys/surveys/link-surveys/embed-surveys", - "xm-and-surveys/surveys/link-surveys/market-research-panel", - "xm-and-surveys/surveys/link-surveys/pin-protected-surveys", + "xm-and-surveys/surveys/link-surveys/personal-links", "xm-and-surveys/surveys/link-surveys/single-use-links", "xm-and-surveys/surveys/link-surveys/source-tracking", "xm-and-surveys/surveys/link-surveys/start-at-question", - "xm-and-surveys/surveys/link-surveys/verify-email-before-survey" + "xm-and-surveys/surveys/link-surveys/verify-email-before-survey", + "xm-and-surveys/surveys/link-surveys/market-research-panel", + "xm-and-surveys/surveys/link-surveys/pin-protected-surveys" ] } ] diff --git a/docs/xm-and-surveys/surveys/link-surveys/personal-links.mdx b/docs/xm-and-surveys/surveys/link-surveys/personal-links.mdx new file mode 100644 index 0000000000..1cb073b030 --- /dev/null +++ b/docs/xm-and-surveys/surveys/link-surveys/personal-links.mdx @@ -0,0 +1,121 @@ +--- +title: "Personal Links" +description: "Personal Links enable you to generate unique survey links for individual contacts, allowing you to attribute responses directly to specific people and set expiry dates for better control over survey distribution." +icon: "user" +--- + + + Personal Links are currently in beta and not yet available for all users. + + + + Personal Links are part of the [Enterprise Edition](/self-hosting/advanced/license). + + +## When to use Personal Links + +Personal Links are ideal when you need to: + +- **Track individual responses**: Associate survey responses with specific contacts in your database +- **Enable targeted follow-ups**: Know exactly who responded and who didn't for personalized outreach +- **Control survey access**: Set expiry dates to limit when links can be used +- **Maintain data integrity**: Ensure each contact can only submit one response per survey + +## How Personal Links work + +When you generate personal links: + +1. **Individual URLs**: Each contact receives a unique survey link tied to their contact record +2. **Automatic attribution**: Responses are automatically linked to the specific contact who clicked the link +3. **Single-use by default**: Each link can only be used once to prevent duplicate responses +4. **Expiry control**: Set expiration dates to control survey access windows + +## Generating Personal Links + + + + Navigate to your survey summary page and click the **Share survey** button in the top bar. + + + + In the Share Modal, click on the **Personal Links** tab. + + + + Select the contact segment you want to generate links for using the dropdown menu. + + + If no segments are available, you'll see "No segments available" in the dropdown. Create segments first in your Contact Management section. + + + + + Choose an expiry date for your links. You can only select dates starting from tomorrow onwards. + + + Links expire at 00:00:00 UTC on the day after your selected date. This means links remain valid through the entirety of your chosen expiry date. + + + + + Click **Generate & download links** to create your personal links and download them as a CSV file. + + + +## Understanding the CSV export + +Your downloaded CSV file contains the following columns in this order: + +| Column | Description | +|--------|-------------| +| **Formbricks Contact ID** | Internal contact identifier (`contactId`) | +| **Custom ID** | Your custom user identifier (`userId`) | +| **First Name** | Contact's first name | +| **Last Name** | Contact's last name | +| **Email** | Contact's email address | +| **Personal Link** | Unique survey URL for this contact | + + +Use the Custom ID column to match contacts with your existing systems, and the Personal Link column for distribution via your preferred communication channels. + + +## Limitations and considerations + + +Keep these limitations in mind when using Personal Links + + +- **Single-use only**: Each personal link can only be used once +- **Enterprise feature**: Requires EE license with Contact Management enabled +- **Segment requirement**: You must have contacts organized in segments +- **CSV storage**: Generated link lists are not retained in Formbricks - download and store your CSV files securely + +## Troubleshooting + +### Common issues + + + + **Issue**: Dropdown shows "No segments available" + + **Solution**: Create contact segments in your Contact Management section before generating personal links. + + + + **Issue**: "Something went wrong" error message + + **Solution**: + - Check your internet connection + - Verify you have sufficient contacts in the selected segment + - Contact support if the issue persists + + + + **Issue**: Personal links lead to error pages + + **Solution**: + - Verify the link hasn't expired + - Check that the survey is still published + - Ensure the link hasn't been used already (single-use limitation) + + \ No newline at end of file diff --git a/docs/xm-and-surveys/surveys/link-surveys/single-use-links.mdx b/docs/xm-and-surveys/surveys/link-surveys/single-use-links.mdx index 2100ea10f1..a5645da8e2 100644 --- a/docs/xm-and-surveys/surveys/link-surveys/single-use-links.mdx +++ b/docs/xm-and-surveys/surveys/link-surveys/single-use-links.mdx @@ -18,7 +18,7 @@ This guide will help you understand how to generate and use single-use links wit that.](https://documenter.getpostman.com/view/11026000/2sA3Bq5XEh#c49ef758-a78a-4ef4-a282-262621151f08) -## Using Single-Use Links with Formbricks +## How to use single-use links Using single-use links with Formbricks is quite straight-forward: @@ -32,7 +32,7 @@ Using single-use links with Formbricks is quite straight-forward: Here, you can copy and generate as many single-use links as you need. -## URL Encryption +## 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: diff --git a/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx b/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx index e947650524..2494eca84a 100644 --- a/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx +++ b/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx @@ -5,7 +5,7 @@ icon: "bullseye" --- - In self-hosting instances advanced Targeting is part of the [Enterprise Edition](/self-hosting/advanced/license). + Advanced Targeting is part of the [Enterprise Edition](/self-hosting/advanced/license). ### When to use Advanced Targeting?