docs: Personal Link docs (#6034)

Co-authored-by: Dhruwang <dhruwangjariwala18@gmail.com>
This commit is contained in:
Johannes
2025-07-10 00:13:29 -07:00
committed by GitHub
parent 18ba5bbd8a
commit 5c2860d1a4
4 changed files with 128 additions and 6 deletions

View File

@@ -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"
]
}
]

View File

@@ -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"
---
<Note>
Personal Links are currently in beta and not yet available for all users.
</Note>
<Note>
Personal Links are part of the [Enterprise Edition](/self-hosting/advanced/license).
</Note>
## 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
<Steps>
<Step title="Access the share modal">
Navigate to your survey summary page and click the **Share survey** button in the top bar.
</Step>
<Step title="Select Personal Links tab">
In the Share Modal, click on the **Personal Links** tab.
</Step>
<Step title="Choose your segment">
Select the contact segment you want to generate links for using the dropdown menu.
<Note>
If no segments are available, you'll see "No segments available" in the dropdown. Create segments first in your Contact Management section.
</Note>
</Step>
<Step title="Set expiry date (optional)">
Choose an expiry date for your links. You can only select dates starting from tomorrow onwards.
<Warning>
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.
</Warning>
</Step>
<Step title="Generate and download">
Click **Generate & download links** to create your personal links and download them as a CSV file.
</Step>
</Steps>
## 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 |
<Tip>
Use the Custom ID column to match contacts with your existing systems, and the Personal Link column for distribution via your preferred communication channels.
</Tip>
## Limitations and considerations
<Warning>
Keep these limitations in mind when using Personal Links
</Warning>
- **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
<Tabs>
<Tab title="No segments available">
**Issue**: Dropdown shows "No segments available"
**Solution**: Create contact segments in your Contact Management section before generating personal links.
</Tab>
<Tab title="Generation failed">
**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
</Tab>
<Tab title="Links not working">
**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)
</Tab>
</Tabs>

View File

@@ -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)
</Note>
## 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:

View File

@@ -5,7 +5,7 @@ icon: "bullseye"
---
<Note>
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).
</Note>
### When to use Advanced Targeting?