Update a webhook subscription

Updates url, event types, and/or status (active|paused) of a webhook subscription

Path Parameters

subscriptionId
Type: string
required

Subscription identifier

Body

application/json

eventTypes
Type: array of string 1…
min length:
1
status
Type: "active" or "paused"enum
url
Type: string
max length:
2048Format: uri

Responses

application/json

patch/webhooks/v1/subscriptions/{subscriptionId}

curl 'https://api.specs.wseng.ai/webhooks/v1/subscriptions/{subscriptionId}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "paused"
}'

Show Schema

{
  "subscriptionId": "sub_01HQXYZ",
  "url": "https://example.com/webhooks/spec-viewer",
  "eventTypes": [
    "specification.updated",
    "comment.created"
  ],
  "status": "active",
  "createdAt": "2024-06-15T10:30:00.000Z"
}

Get a webhook subscription

Delete a webhook subscription