API Reference

Update webhook subscription

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.

PATCH/v1/subscriptions/{id}

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.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Subscription ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/subscriptions/string" \  -H "Content-Type: application/json" \  -d '{    "active": true,    "events": [      "CertificateIssued.v2",      "CertificateFailed.v1"    ]  }'
{  "subscription": {    "active": true,    "createdAt": "string",    "events": [      "string"    ],    "health": "string",    "id": "string",    "kmsKeyId": "string",    "ownerPrincipalId": "string",    "url": "string"  }}

Get webhook subscription GET

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

Disable webhook subscription DELETE

Requires subscriptions:manage and owner access. Disables the webhook subscription instead of deleting its history, then returns an empty response.