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

Delete a notification destination

Update a notification destination PATCH

Only the fields you send change. A coding agent takes a new `token`, and no `events`. Requires `notificationDestination:update` and a plan with the type's feature (Discord: `integrations`, webhook: `webhooks`, coding agents: `agents`).

Send a test message POST

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`).

DELETE
/v1/notification-destinations/{destinationId}

Requires notificationDestination:delete.

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

Deleted

Example Request
curl -X DELETE 'https://api.annoty.app/v1/notification-destinations/string'
Example Response
Empty