Projects

Targeted Respondents

Diaform projects can run in two access modes:

  • Public link: anyone with the share URL can start a new conversation
  • Invite-only links: only respondents with a generated link can start or resume a conversation

Use Invite-only links when you want to:

  • send a unique link to a specific person
  • attach your own identifiers such as external_user_id
  • keep the link alive until that conversation is finished
  • stop the link from being reused once the conversation is completed

How It Works#

  1. Open the project's General settings.
  2. Change Respondent access to Invite-only links.
  3. Generate a respondent link manually, or create links programmatically via the API.
  4. Send that link to the intended respondent.
  5. Diaform creates the conversation only after that targeted link is opened.
  6. The same link resumes the same conversation until it is completed.
  7. Once the conversation is completed, the link stops working.

What Metadata You Can Attach#

Each respondent link can carry:

  • invitee_email
  • external_user_id
  • external_account_id
  • metadata as a JSON object

Diaform copies those values onto the conversation record. They are then available in:

  • the Respondent Conversations API
  • webhook payloads for conversation.completed
  • CSV exports

Security Model#

Targeted respondent links are bearer links. Anyone who has the full link can open it.

That means:

  • Diaform enforces that the conversation can only be started through a valid generated link
  • Diaform does not verify the respondent’s mailbox or identity in v1
  • if you need stronger identity guarantees, launch the link from your own authenticated product surface

Programmatic Access#

Enterprise workspaces can generate respondent links programmatically with organization API keys.

See: