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

List a destination's deliveries GET

Newest first, from the last 30 days. Requires `notificationDestination:read`.

Redeliver POST

Sends the same body again, with the same `webhook-id`, and retries on the usual schedule. Refused (409) while the delivery is still pending or the destination is turned off. Requires `notificationDestination:update` and a plan with the destination type's feature.

GET
/v1/notification-deliveries/{deliveryId}

The body holds comment text, so this also requires comment:read, besides 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

deliveryId*string

Response Body

The delivery

application/json
  1. response
  1. response
  2. …
id*string
destinationId*string
eventId*string

The activity event's id, also a webhook's webhook-id header. A test gets its own

eventType*|

Null for Discord's test message, which is no event, and for a comment sent to a coding agent

Value in"comment.created""comment.replied""comment.resolved""comment.reopened""feedback_session.created""feedback_session.deactivated""feedback_session.expired""feedback_session.deleted"null
test*boolean

Sent from "Send test"

status*string

pending: being tried, next at nextAttemptAt. failed: every attempt failed, one failed in a way a retry can't fix, or the destination was turned off. A failed delivery is tried 8 times over about a day

Value in"pending""delivered""failed"
attemptCount*integer
nextAttemptAt*|
Formatdate-time
lastStatusCode*|

What the last attempt got back; null without a response

lastError*string|null
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
body*string

The request body as sent, JSON. Every attempt sends the same

attempts*array<>
Example Request
curl -X GET 'https://api.annoty.app/v1/notification-deliveries/string'
Example Response
{
  "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",
  "body": "string",
  "attempts": [
    {
      "attempt": 0,
      "statusCode": 0,
      "error": "string",
      "responseBody": "string",
      "durationMs": 0,
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}