About the Feedback Sessions API

The Feedback Sessions API lets you open a round of review on a site. A feedback session is a shareable link: anyone holding it can review the site and leave comments on its pages. Studio partners and agencies use it to collect client feedback on a site before handing it over.

With the Feedback Sessions API, you can:

• Create a feedback session on a site and get the URL to share with reviewers.
• Retrieve and query a site's feedback sessions, for example to list the ones still collecting feedback.
• Delete feedback sessions you no longer need.

The comments left through a feedback session are managed with the Comments API. Every comment carries the ID of its feedback session in feedbackId.

Sharing a feedback session

A feedback session's shareUrl is the link you send to reviewers. Anyone with the link can review the site and leave comments through the session, without logging in.

shareUrl is returned only when you set fields to SHARE_URL in Create Feedback Session, Get Feedback Session, or Query Feedback Sessions. It requires the site to have a URL, so it isn't returned while the site has no URL, or when the site's URL can't be retrieved. To retry, call Get Feedback Session with SHARE_URL.

The Wix user who created the feedback session is notified by email about new comments left through it.

Expiration

A feedback session accepts new comments until its expirationDate, which defaults to 14 days after creation. You can set it only when creating the session.

Once a session expires, it stops accepting new comments. The comments already left through it stay readable, and can still be triaged and replied to with the Comments API.

Before you begin

It's important to note the following points before starting to code:

• Feedback sessions are created on behalf of a Wix user. Apps, including calls made with an API key, can retrieve and delete feedback sessions, but can't create them.
• A feedback session can't be updated once created. To change its expiration date, create a new feedback session.
• Feedback sessions are scoped to a single site. Every call resolves within the site in the request context. When calling with an API key, specify the site in the wix-site-id header.
• Deleting a feedback session doesn't delete the comments left through it. To remove them, call Delete Comment for each one.

Use cases

• Collect client feedback on a site before handover
• List the review links still collecting feedback
• Clean up expired feedback sessions

Terminology

• Feedback session: A round of review on a site, shared as a link. It collects comments until it expires.
• Share URL: The link to a feedback session that you send to reviewers.
• Reviewer: Anyone who opens a feedback session's share URL to review the site.
• Comment: A note a reviewer pins to a specific point on a site page through a feedback session.