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 notification destinations GETAdd a notification destination POSTGet a notification destination GETUpdate a notification destination PATCHDelete a notification destination DELETESend a test message POSTGet a webhook's signing secret GETGive a webhook a new signing secret POSTGet your notification preferences for a project GETSet your notification preferences for a project PUTList a destination's deliveries GETGet a delivery with its body and attempts GETRedeliver POST
REST APINotifications

Add a notification destination

List a project's notification destinations GET

Newest first, including those for a single feedback session. Requires `notificationDestination:read`.

Get a notification destination GET

Requires `notificationDestination:read`.

POST
/v1/projects/{projectId}/notification-destinations

Up to 10 per project, coding agents included. A webhook's response has its signing secret. Requires notificationDestination:create and a plan with the type's feature (Discord: integrations, webhook: webhooks, coding agents: agents). Webhooks are refused (400) while they aren't available to the organization yet.

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

projectId*string

Request Body

application/json
  1. body
  1. body
  2. …
name*string
Length1 <= length <= 100
events?array<>

The activity events this receives

Items1 <= items
Default
[
  "comment.created"
]
feedbackSessionIds?array<string>

Only these feedback sessions' events, muted or not. Empty: every feedback session in the project that isn't muted. Fixed once created; deleting the last of them deletes the destination

Itemsitems <= 100
Default[]
enabled?boolean
Defaulttrue
type*"discord"
Value in"discord"
url*string

Discord: channel settings → Integrations → Webhooks → Copy Webhook URL

Response Body

The created notification destination

application/json
  1. response
  1. response
  2. …
id*string
projectId*string
feedbackSessionIds*array<string>

The feedback sessions whose events it gets. Empty: every feedback session in the project that isn't muted

type*string

discord: a Discord channel's webhook. slack: a channel in a Slack workspace connected with POST /slack/install. webhook: any https URL, signed the Standard Webhooks way. claude_code: a Claude Code scheduled task's API trigger. github_actions: repository_dispatch on a GitHub repository, for Claude Code's or Codex's GitHub Action. cursor: a Cursor cloud agent on a GitHub repository. The last three are coding agents: POST …/comments/{commentId}/send-to-agent sends them a comment

Value in"discord""slack""webhook""claude_code""github_actions""cursor"
name*string
urlPreview*string

The URL without its secret part: Discord's webhook id; a webhook's host, its path's first segment when more follow and the last 4 characters of the rest (n8n.acme.dev/webhook-test/…f3a9); a Claude Code trigger's id or a GitHub repository. The URL and any token are never returned

events*array<>

The activity events this receives. Empty for coding agents (claude_code, github_actions): they get only the comments a member sends them

enabled*boolean
lastError*|

Why the last delivery failed. A webhook deleted on Discord's side also sets enabled to false

lastErrorAt*|
Formatdate-time
hasAnnotyApiKey*boolean

cursor: an Annoty API key is stored for the agent's MCP server, so it can read the whole comment and reply. Always false for other types

createdAt*string
Formatdate-time
secret*|

webhook: the signing secret. Null for every other type

Example Request
curl -X POST 'https://api.annoty.app/v1/projects/string/notification-destinations' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "type": "discord",
  "url": "string"
}'
Example Response
{
  "id": "string",
  "projectId": "string",
  "feedbackSessionIds": [
    "string"
  ],
  "type": "discord",
  "name": "string",
  "urlPreview": "string",
  "events": [
    "comment.created"
  ],
  "enabled": true,
  "lastError": "string",
  "lastErrorAt": "2019-08-24T14:15:22Z",
  "hasAnnotyApiKey": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "secret": "string"
}