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

Send a test message

Delete a notification destination DELETE

Requires `notificationDestination:delete`.

Get a webhook's signing secret GET

The secret deliveries are signed with now. Webhooks only (400 otherwise). Requires `notificationDestination:update`, like rotating it.

POST
/v1/notification-destinations/{destinationId}/test

Posts right away, even while the destination is turned off, and logs it as a delivery with test: true: Discord gets a short message, a webhook a sample comment.created with test: true. A Claude Code task gets a text that says it's a test, which still starts a run; a GitHub repository gets a dispatch of type annoty-test, which starts only workflows that list it. A webhook deleted on Discord's side, one that answers 410, or an agent whose token is refused, turns it off. Requires notificationDestination:update and a plan with the type's feature (Discord: integrations, webhook: webhooks, coding agents: agents).

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

destinationId*string

Response Body

What happened

application/json
  1. response
  1. response
  2. …
delivered*boolean
deliveryId*string

The test in the destination's delivery log

error*|

Why it wasn't delivered; also stored as the destination's lastError

destination*
Example Request
curl -X POST 'https://api.annoty.app/v1/notification-destinations/string/test'
Example Response
{
  "delivered": true,
  "deliveryId": "string",
  "error": "string",
  "destination": {
    "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"
  }
}