Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
List a project's feedback sessions GETCreate a feedback session POSTList the organization's feedback sessions GETGet a feedback session GETUpdate a feedback session PATCHDelete a feedback session DELETEList where a feedback session was opened GET
REST APIFeedback sessions

Update a feedback session

Get a feedback session GET

Requires `feedbackSession:read`.

Delete a feedback session DELETE

Deletes its comments too, and disconnects open widgets. Only your organization can reuse its proxy link's slug for the next 60 days. Requires `feedbackSession:delete`.

PATCH
/v1/feedback-sessions/{feedbackSessionId}

Only the fields you send change. proxy adds or removes the proxy link; a proxy link's slug can't change. Turning a feedback session back on needs room in the plan's maxFeedbackSessions, and setting a password a proxy link and a plan with feedbackSessionPassword. Fails with 409 when a new proxy link's slug is taken. Requires feedbackSession:update.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Path Parameters

feedbackSessionId*string

Request Body

application/json
  1. body
  1. body
  2. …
label?string
Length1 <= length <= 100
targetUrl?string

The site reviewers see, with the comment widget added

Formaturi
Lengthlength <= 2048
isActive?boolean

false turns the proxy link and the embed link off and keeps the comments

expiresAt?|

The proxy link and the embed link stop working after this. Null for never.

Formatdate-time
notificationsMuted?boolean
proxy?boolean

true adds a proxy link, with slug or a random one; it's a no-op when there is one. false removes it with its password: its slug stays with your organization for 60 days, so adding it back in that time can take the same slug. The embed link works either way.

slug?string

The new proxy link's subdomain, with proxy: true on a feedback session without one. A proxy link's slug can't be changed.

Length3 <= length <= 63
password?|

A new password asks every browser for it again. Null removes it, which every plan can do.

Length6 <= length <= 100

Response Body

The updated feedback session

application/json
  1. response
  1. response
  2. …
id*string
projectId*string
label*string
dataSession*|

Set when the project embed link created this feedback session: the embed script's data-session, or the page's host without one, slugified. The project embed link opens this feedback session again wherever the embed script names it.

slug*|

The proxy link's subdomain on annoty.site; null without a proxy link

proxyUrl*|

The proxy link: the target site on annoty.site with the comment toolbar on top. Nothing to install on the site. Anyone who has it can read and post comments. Null when the feedback session has none (proxy: false): reviewers open it with embedUrl only.

password*|

The proxy link asks for it before it shows the site, once per browser; null when it doesn't, or when there's no proxy link. Members who open the feedback session from the dashboard skip it. The embed link never asks for it. An empty string when it can't be read back: set a new one.

targetUrl*string
embedKey*string

The embed link's key. Put it in the embed script's data-key to open the toolbar on the target site without a link, for everyone who loads the page: that makes it public on the page. Anyone who has it can read and post comments.

embedUrl*string

The embed link: the target URL with an embed key in its fragment, which opens the comment toolbar on the site itself. Works once the site loads the embed script (embedScriptUrl), including behind a login. Like proxyUrl, anyone who has it can read and post comments.

embedScriptUrl*string

The embed script, which the target site loads on every page for embedUrl to work: <script async src="…"></script>. The same for every feedback session.

isActive*boolean
expiresAt*|
Formatdate-time
commentCount*integer

Comment threads; replies aren't counted

openCommentCount*integer
notificationsMuted*boolean

The project's notification destinations skip this feedback session; its own destinations still get its events

status*string

inactive when isActive is false, expired once expiresAt has passed. Only active feedback sessions open and count toward the plan's maxFeedbackSessions.

Value in"active""inactive""expired"
createdAt*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.annoty.app/v1/feedback-sessions/string' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "projectId": "string",
  "label": "string",
  "dataSession": "string",
  "slug": "string",
  "proxyUrl": "string",
  "password": "string",
  "targetUrl": "string",
  "embedKey": "string",
  "embedUrl": "string",
  "embedScriptUrl": "string",
  "isActive": true,
  "expiresAt": "2019-08-24T14:15:22Z",
  "commentCount": 0,
  "openCommentCount": 0,
  "notificationsMuted": true,
  "status": "active",
  "createdAt": "2019-08-24T14:15:22Z"
}