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

Give a webhook a new signing secret

Get a webhook's signing secret GET

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

Get your notification preferences for a project GET

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

POST
/v1/notification-destinations/{destinationId}/rotate-secret

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.

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

The new secret

application/json
  1. response
  1. response
  2. …
secret*string

The webhook's signing secret: keep it to check webhook-signature. GET /notification-destinations/{destinationId}/secret returns it again

destination*
Example Request
curl -X POST 'https://api.annoty.app/v1/notification-destinations/string/rotate-secret'
Example Response
{
  "secret": "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"
  }
}