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

Get your notification preferences for a project

Give a webhook a new signing secret POST

The old secret stops working at once: deliveries from now on, retries included, are signed with the new one. Webhooks only (400 otherwise). Requires `notificationDestination:update` and a plan with `webhooks`.

Set your notification preferences for a project PUT

Replaces the calling member's own; API keys get 403. Requires `project:read` and a plan with `notifications`. `email: true` is refused (400) while email notifications aren't available to the organization yet.

GET
/v1/projects/{projectId}/notification-preferences

The calling member's own; API keys get 403. Requires project:read.

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

Response Body

Your notification preferences

application/json
  1. response
  1. response
  2. …
projectId*string
email*boolean

Email notifications of this project's activity, grouped into one email about 10 minutes after the first event. Never about your own actions

events*array<>

The activity events this receives

Items1 <= items
Example Request
curl -X GET 'https://api.annoty.app/v1/projects/string/notification-preferences'
Example Response
{
  "projectId": "string",
  "email": true,
  "events": [
    "comment.created"
  ]
}