Glossary
The words Annoty uses in the dashboard, the docs and the API.
| Term | What it means | In the API |
|---|---|---|
| Project | One website you collect feedback on. Holds its feedback sessions. | Project, prj_… |
| Feedback session | One review round on a project's site, like "Homepage v2". Reviewers open it with its embed link, or its proxy link if it has one; both lead to the same comments. | FeedbackSession, fbs_… |
| Proxy | Reviewing through annoty.site: Annoty loads your site there with the comment toolbar on top. Nothing to install. Proxy | |
| Proxy link | A feedback session's address on annoty.site, like https://homepage-redesign-k3x9m2qa.annoty.site. Only when you choose one. | proxyUrl, slug |
| Embed | Reviewing on your own site, which loads the embed script. Works behind logins. Pro and Team. Embed | |
| Embed script | The script tag you add to every page of your site once: <script async src="https://api.annoty.app/embed/embed.js"></script>. With the key in data-key, it opens the toolbar without a link. | embedScriptUrl |
| Embed link | One feedback session's link on your own site: its page with #annoty=rk_… added. | embedUrl |
| Project embed link | One link for every page of a project's sites: #annoty=rp_…. The embed script's data-session picks the feedback session. | embedUrl, embedKey |
| Embed key | The rk_… or rp_… part of an embed link, or the embed script's data-key. Whoever has it can comment. | embedKey |
| Allowed sites | Where the project embed link works besides the project's domain, like staging and preview deploys. | allowedHosts |
| Reviewer | Anyone who opens a proxy link or an embed link to comment. Reviewers don't need an account. | |
| Member | Someone in your organization. Members sign in from the toolbar to comment as themselves and resolve threads. |