Skip to Content
annotyDocs

Proxy

Share a link on annoty.site. Nothing to install on your site.

The proxy link opens your site on its own address on annoty.site, with the comment toolbar on top:

https://homepage-redesign-k3x9m2qa.annoty.site

As reviewers browse, Annoty fetches each page from your site and adds the toolbar before showing it. Your site's code stays as it is, so a public page is ready for review as soon as you have its URL. Your site's redirects work too: example.com and www.example.com both open on the proxy link.

  1. In the dashboard, open a project and click New feedback session.

  2. Enter a label, like "Homepage v2", and turn Proxy link on.

  3. Enter the page reviewers start on. Optional: change the name in Address, or pick when it Expires.

  4. Click Create feedback session, then Share on its page. The Proxy tab has the link to copy.

Reviewers open the link, type their name and start commenting. They don't need an account.

A feedback session you created with Proxy link left off, or one the project embed link created, has no proxy link, so your site isn't on annoty.site. To give it one, click Share, switch to the Proxy tab, check the name and click Add proxy link.

Remove proxy link in the same tab ends the link for everyone who has it, and its password with it. The embed link keeps working and the comments stay. Your organization keeps the name for 60 days, so you can add the same link back in that time.

Through the REST API, send proxy: true when you create or update the feedback session, with slug for your own name, and proxy: false to remove it.

By default the proxy link is the label plus 8 random characters, like homepage-redesign-k3x9m2qa. Anyone with the link can read and post comments, and the random part makes it hard to guess. You can type your own name instead, but a short name is easy to guess: give it a password. The name can't be changed once the link exists.

Protect it with a password

On Pro and Team, a feedback session can have a password. Its proxy link then asks for it before it shows your site.

  1. Type a Password when you create the feedback session with a proxy link, or add one later with Edit.

  2. Send reviewers the password along with the proxy link, ideally in another message. Share has both to copy in its Proxy tab.

Reviewers enter the password once in each browser, and again after you change it. To remove it, clear Password under Edit. Team members who click Open skip it.

The password covers the proxy link only. The embed link doesn't ask for it: there, its embed key and your site's own login decide who gets in.

Through the REST API, send password when you create or update the feedback session, or null to remove it. It needs a proxy link.

When the proxy can't help

These usually don't work through the proxy:

  • a login on your site
  • Vercel or Netlify preview protection, or a password on a staging server
  • pages on another subdomain, like shop.example.com from www.example.com: links there open that site itself, without the toolbar

For those, and for any page that doesn't work right on annoty.site, use embed. Every feedback session has an embed link too, with the same comments. Without the proxy link, Open on the feedback session's page opens the embed link instead.

Team members

Click Open on the feedback session's page to review signed in. On a link someone sent you, open the toolbar's Preferences and click Sign in next to Team member?.

Signed in, your comments carry your name, and you can resolve and delete any thread your role allows. Reviewers who aren't signed in can resolve, reopen and delete only their own comments.

On this page