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
Start connecting a Slack workspace POSTFinish connecting a Slack workspace POSTList connected Slack workspaces GETDisconnect a Slack workspace DELETEList a workspace's channels GETSee what a Slack link would connect GETList the signed-in member's linked Slack accounts GETLink a Slack account to the signed-in member POSTUnlink a Slack account DELETE
REST APISlack

Finish connecting a Slack workspace

Start connecting a Slack workspace POST

The address to send the signed-in member's browser to. Session only. Requires `notificationDestination:create` and a plan with `integrations`.

List connected Slack workspaces GET

Requires `notificationDestination:read`.

POST
/v1/slack/install/complete

What Slack sent back to the dashboard. The signed-in member must be the one who started it, so nobody can get a member to connect a workspace to another organization. Session only.

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.

Request Body

application/json
  1. body
  1. body
  2. …
code*string
Length1 <= length
state*string
Length1 <= length

Response Body

Connected

application/json
  1. response
  1. response
  2. …
teamId*string
teamName*string
projectId*|

The project to return to

Example Request
curl -X POST 'https://api.annoty.app/v1/slack/install/complete' \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "string",
  "state": "string"
}'
Example Response
{
  "teamId": "string",
  "teamName": "string",
  "projectId": "string"
}