For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Webhook subscription management (delete, secret rotation, delivery log)

Rotate the HMAC signing secret for a webhook subscription

post

Generates a new HMAC-SHA256 secret for the subscription. The new secret is returned in the response and is only returned once — store it immediately. After rotation, deliveries will be signed with the new secret. Allow a short overlap window before decommissioning the old secret on the consumer side.

Authorizations
Path parameters
idinteger · int64Required

The webhook subscription ID

Responses
200

New HMAC secret generated successfully

idinteger · int64Optional

Webhook subscription ID

secretstringOptional

New HMAC-SHA256 signing secret. This value is only returned once. Store it immediately — it cannot be retrieved again.

rotatedAtstring · date-timeOptional

Timestamp when the secret was rotated

post/v1/webhooks/{id}/secret
POST /v1/webhooks/{id}/secret HTTP/1.1
Host: connect2.tsanet.org
Accept: */*
{
  "id": 1,
  "secret": "text",
  "rotatedAt": "2026-01-01T00:00:00.000Z"
}

Get delivery log for a webhook subscription

get
Authorizations
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

totalElementsinteger · int64Optional
totalPagesinteger · int32Optional
sizeinteger · int32Optional
numberinteger · int32Optional
get/v1/webhooks/{id}/deliveries
GET /v1/webhooks/{id}/deliveries HTTP/1.1
Host: connect2.tsanet.org
Accept: */*
{
  "content": [
    {
      "id": 1,
      "cloudEventId": "text",
      "eventType": "text",
      "httpStatus": 1,
      "attemptNumber": 1,
      "success": true,
      "requestBody": "text",
      "responseBody": "text",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}

Delete a webhook subscription

delete
Authorizations
Path parameters
idinteger · int64Required

The webhook subscription ID

Responses
204

Webhook subscription deleted successfully

No content

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

No content

Last updated