Update vault webhook subscription

Updates callback URL, filters, active state, or signing secret for a vault webhook subscription.

PATCH /vault/{id}/events/subscriptions/{subscriptionId}

Update vault webhook subscription

cURL

curl --request PATCH \
  --url https://api.case.dev/vault/{id}/events/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callbackUrl": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "objectIds": [
    "<string>"
  ],
  "isActive": true,
  "signingSecret": "<string>",
  "clearSigningSecret": true
}
'

Authorizations

Authorization · string · header · required

API key starting with sk_case_

Path Parameters

id · string · required

Vault ID

subscriptionId · string · required

Subscription ID

Body

application/json

callbackUrl · string<uri>

Updated webhook endpoint URL for deliveries

eventTypes · string[]

Updated event types to deliver for this subscription

objectIds · string[]

Updated vault object IDs to limit notifications to. Pass an empty array to remove the filter.

isActive · boolean

Whether the subscription should continue delivering events

signingSecret · string

Replacement secret used to sign webhook deliveries

clearSigningSecret · boolean

Whether to remove the existing signing secret

Response

200

Vault webhook subscription updated successfully