Webhooks V1

V1 webhook subscriptions (legacy flat JSON — collaboration-request.created and note.created only)

Deprecated

List webhook subscriptions for the current company

get

Deprecated — use GET /v2/webhooks instead. This endpoint will be removed after 2027-01-01.

Authorizations

Responses

200

List of webhook subscriptions

idinteger · int64Optional

callbackUrlstringOptional

payloadVersionstring · enumOptionalPossible values:

activebooleanOptional

callbackAuthTypestringOptional

The authentication type configured for this subscription. Credential values are never returned.

Example: BASIC

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

401

Unauthorized

get/v1/webhooks

GET /v1/webhooks HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

[
  {
    "id": 1,
    "callbackUrl": "text",
    "eventTypes": [
      "collaboration-request.created"
    ],
    "payloadVersion": "V1",
    "active": true,
    "callbackAuthType": "BASIC",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Deprecated

Register a new V1 webhook subscription (legacy flat JSON)

post

Deprecated — use POST /v2/webhooks instead. This endpoint will be removed after 2027-01-01. Subscribe to receive legacy flat JSON webhook notifications for collaboration-request.created and note.created events. For new integrations, prefer POST /v2/webhooks which delivers all 5 event types as CloudEvents 1.0 structured payloads. Security: Every delivery is signed with HMAC-SHA256. The signature is sent in the X-Hub-Signature-256 header as sha256=<hex>. Verify it using the secret returned on subscription creation (rotate via POST /v1/webhooks/{id}/secret). Retries: Failed deliveries are retried up to 4 additional times (5 total attempts) with exponential backoff starting at 10s, doubling each attempt, capped at 300s. Messages that exhaust all retries are moved to a dead-letter queue. Contact TSANet support to replay dead-lettered deliveries.

Authorizations

Body

callbackUrlstring · uriRequired

The URL to receive webhook events. Must be accessible via HTTPS in production.

Example: https://api.example.com/webhooks/tsanet

Responses

200

Webhook subscription created successfully

idinteger · int64Optional

callbackUrlstringOptional

payloadVersionstring · enumOptionalPossible values:

activebooleanOptional

secretstringOptional

HMAC secret for signing webhooks (only returned on creation — use POST /v1/webhooks/{id}/secret to rotate)

callbackAuthTypestringOptional

The authentication type configured for this subscription. Credential values are never returned.

Example: BASIC

createdAtstring · date-timeOptional

400

Bad request

401

Unauthorized

post/v1/webhooks

POST /v1/webhooks HTTP/1.1
Host: connect2.tsanet.org
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "callbackUrl": "https://api.example.com/webhooks/tsanet",
  "eventTypes": [
    "collaboration-request.created",
    "note.created"
  ],
  "callbackAuth": {
    "type": "NONE",
    "username": "text",
    "password": "text",
    "token": "text",
    "headerName": "text",
    "headerValue": "text"
  }
}

{
  "id": 1,
  "callbackUrl": "text",
  "eventTypes": [
    "collaboration-request.created"
  ],
  "payloadVersion": "V1",
  "active": true,
  "secret": "text",
  "callbackAuthType": "BASIC",
  "createdAt": "2026-01-01T00:00:00.000Z"
}