Update Webhook Subscription

Modify webhook subscription metadata, events, or status.

Method

PATCH /v1/webhooks/subscriptions/:id

Path Parameters

id · uuid · required

Webhook subscription ID.

Headers

Authorization · string

Bearer token (requires webhooks:write).

content-type · string

application/json

Body Parameters

All fields are optional; include only the properties you want to change.

Request Example

cURL

curl -X PATCH "https://api.voyantcloud.com/v1/webhooks/subscriptions/whsub_01J0J3Y3TFX2V22Y7DQ0A6J5G5" \
  -H "Authorization: Bearer $VOYANT_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "events": ["booking.*"],
    "active": false,
    "headers": null
  }'

Response Example

200 OK

{
  "data": {
    "id": "whsub_01J0J3Y3TFX2V22Y7DQ0A6J5G5",
    "workspace_id": "ws_4a82d5bd-3330-4ad3-bf46-1b6a9a5d5d6a",
    "url": "https://example.com/webhooks/voyant",
    "events": ["booking.*"],
    "active": false,
    "max_retries": 3,
    "headers": null,
    "description": "Critical booking feed",
    "created_at": "2025-03-01T09:12:33.000Z",
    "updated_at": "2025-03-10T11:45:00.000Z",
    "last_delivery_at": "2025-03-09T18:11:04.000Z",
    "failure_count": 0
  }
}