Update a webhook endpoint
PATCH /api/v1/webhooks/{id}
PATCH https://api.trustverify.co.uk/api/v1/webhooks/{id}
Partial update of an owned endpoint — send only the fields to change. A changed url is re-screened against SSRF rules before being saved. Needs a live key. The response does not include the signing secret.
Parameters#
| Field | Type | Description |
|---|---|---|
| id (path) | numbernull |
Request body#
| Field | Type | Description |
|---|---|---|
| name | string | |
| url | string | |
| events | array of string | |
| isActive | boolean |
Example request#
curl -sS -X PATCH 'https://api.trustverify.co.uk/api/v1/webhooks/42' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"isActive": false
}'Responses#
200 Updated webhook (no signing secret)
| Field | Type | Description |
|---|---|---|
| idrequired | number | |
| namerequired | string | |
| urlrequired | string | |
| eventsrequired | array of string | |
| isActiverequired | boolean | |
| retryPolicyrequired | object,null | |
| retryPolicy.maxRetriesrequired | number | |
| retryPolicy.backoffrequired | string: "linear" | "exponential" | |
| createdAtrequired | string,null | |
| updatedAtrequired | string,null |
400 validation_failed — non-numeric id, unsafe webhook URL, or invalid fields
403 test_key_cannot_manage_webhooks — endpoints receive production events, so creating, changing or deleting one needs a liv
test_key_cannot_manage_webhooks — endpoints receive production events, so creating, changing or deleting one needs a live key (tv_live_sk_…). A test key can list them.