About the Feedback APIs

The Feedback APIs let you collect and work through feedback on a Wix site. You share a link to the site with reviewers, such as a client, and they leave comments pinned to specific points on its pages. Studio partners and agencies use them to gather client feedback before handing a site over, and to manage that feedback from their own tools.

The Feedback APIs include:

• Feedback Sessions: Open a round of review on a site and get the link to share with reviewers. A feedback session collects comments until it expires.
• Comments: Read, triage, reply to, and delete the comments reviewers leave on a site.

How the APIs fit together

A review round follows the same path through both APIs:

1. You create a feedback session on the site with the Feedback Sessions API, and send its share URL to reviewers.
2. Reviewers open the share URL, review the site, and leave comments on its pages. Anyone with the link can comment, without logging in. The Wix user who created the feedback session is notified by email about new comments.
3. You retrieve the comments left through the session with the Comments API, filtering on feedbackId, which holds the feedback session's ID.
4. You work through each comment, moving it from NEW to OPEN to RESOLVED and replying where needed. A comment returns to NEW when its commenter replies to it or reopens it, so a resolved comment can come back.

A feedback session and its comments have separate lifecycles:

• When a feedback session expires, it stops accepting new comments. The comments already left through it stay readable, and you can still triage and reply to them.
• Deleting a feedback session doesn't delete its comments. You can still retrieve them with the Comments API, and delete them separately.

Before you begin

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

• Both APIs 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.
• There's no method for creating a comment. Comments are left by reviewers through a feedback session's share URL.
• Feedback sessions are created on behalf of a Wix user. Apps, including calls made with an API key, can retrieve and delete feedback sessions and work through their comments, but can't create a feedback session.

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 share URL to review the site. A reviewer who leaves a comment is its commenter.
• Comment: A note a reviewer pins to a specific point on a site page through a feedback session.
  • Reply: A response to a comment, from the commenter or from you.
  • Triage: Moving a comment through the NEW, OPEN, and RESOLVED statuses as you work through it. The commenter can send it back to NEW.