Webhooks

Webhook subscription management for event notifications

List webhook subscriptions for the current company

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of webhook subscriptions

application/jsonapplication/problem+json

idinteger · int64Optional

callbackUrlstringOptional

activebooleanOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

401

Unauthorized

application/jsonapplication/problem+json

get

/v1/webhooks

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "callbackUrl": "text",
    "eventTypes": [
      "collaboration-request.created"
    ],
    "active": true,
    "createdAt": "2026-03-24T19:18:09.764Z",
    "updatedAt": "2026-03-24T19:18:09.764Z"
  }
]

Register a new webhook subscription

post

Subscribe to receive webhook notifications for specific events. When an event occurs, a WebhookPayload will be sent via HTTP POST to your callback URL. Security: The webhook payload is signed using HMAC-SHA256. The signature is sent in the X-Hub-Signature-256 header as sha256=<hex_signature>. Verify the signature using the secret returned upon subscription creation. Payload: See WebhookPayload schema for the structure of events sent to your endpoint. Retries: Failed deliveries are retried up to 3 times with exponential backoff (10s, 60s, 300s).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

application/jsonapplication/problem+json

idinteger · int64Optional

callbackUrlstringOptional

activebooleanOptional

secretstringOptional

HMAC secret for signing webhooks (only returned on creation)

createdAtstring · date-timeOptional

400

Bad request

application/jsonapplication/problem+json

401

Unauthorized

application/jsonapplication/problem+json

post

/v1/webhooks

HTTPcURLJavaScriptPython

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

{
  "callbackUrl": "https://api.example.com/webhooks/tsanet",
  "eventTypes": [
    "collaboration-request.created",
    "note.created"
  ]
}

{
  "id": 1,
  "callbackUrl": "text",
  "eventTypes": [
    "collaboration-request.created"
  ],
  "active": true,
  "secret": "text",
  "createdAt": "2026-03-24T19:18:09.764Z"
}

Get delivery log for a webhook subscription

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

The webhook subscription ID

Query parameters

pageinteger · int32Optional

Page number (0-based)

Default: 0

sizeinteger · int32Optional

Page size

Default: 20

Responses

200

Delivery log

application/jsonapplication/problem+json

totalElementsinteger · int64Optional

totalPagesinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied

application/jsonapplication/problem+json

404

Webhook subscription not found

application/jsonapplication/problem+json

get

/v1/webhooks/{id}/deliveries

HTTPcURLJavaScriptPython

GET /v1/webhooks/{id}/deliveries HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 1,
      "integrationId": 1,
      "eventType": "text",
      "httpStatus": 1,
      "attemptNumber": 1,
      "success": true,
      "requestBody": "text",
      "responseBody": "text",
      "createdAt": "2026-03-24T19:18:09.764Z"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}

Delete a webhook subscription

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idinteger · int64Required

The webhook subscription ID

Responses

204

Webhook subscription deleted successfully

401

Unauthorized

application/problem+json

403

Access denied

application/problem+json

404

Webhook subscription not found

application/problem+json

delete

/v1/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{id} HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content