API Reference

Get webhook subscription

Requires subscriptions:manage and returns one webhook subscription only when it belongs to the authenticated principal. Secret material is never exposed.

GET/v1/subscriptions/{id}

Requires subscriptions:manage and returns one webhook subscription only when it belongs to the authenticated principal. Secret material is never exposed.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Subscription ID.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/subscriptions/string"
{  "subscription": {    "active": true,    "createdAt": "string",    "events": [      "string"    ],    "health": "string",    "id": "string",    "kmsKeyId": "string",    "ownerPrincipalId": "string",    "url": "string"  }}

Create webhook subscription POST

Requires subscriptions:manage. Registers the authenticated principal's public HTTPS callback after URL safety validation, encrypts the shared secret without returning it, and responds with the new subscription.

Update webhook subscription PATCH

Requires subscriptions:manage and owner access. Updates the active flag, event filters, or both; callback URLs and signing secrets are changed through other lifecycle operations.