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

List a destination's deliveries

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 a delivery with its body and attempts GET

The body holds comment text, so this also requires `comment:read`, besides `notificationDestination:read`.

GET
/v1/notification-destinations/{destinationId}/deliveries

Newest first, from the last 30 days. Requires notificationDestination: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

destinationId*string

Query Parameters

limit?integer

Items per page, 1 to 100

Range1 <= value <= 100
Default20
cursor?string

nextCursor from the previous page

status?string

Only these

Value in"pending""delivered""failed"

Response Body

A page of deliveries

application/json
  1. response
  1. response
  2. …
data*array<>
nextCursor*|

Pass as cursor for the next page; null on the last page

Example Request
curl -X GET 'https://api.annoty.app/v1/notification-destinations/string/deliveries'
Example Response
{
  "data": [
    {
      "id": "string",
      "destinationId": "string",
      "eventId": "string",
      "eventType": "comment.created",
      "test": true,
      "status": "pending",
      "attemptCount": 0,
      "nextAttemptAt": "2019-08-24T14:15:22Z",
      "lastStatusCode": 0,
      "lastError": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}