PATCH /v1/webhooks/{id}
Change or re-enable a subscription
Change or re-enable a subscription
Changes only the fields that are sent. Setting enabled: true resets the failure counter. Requires scope write:deals.
- Authentication: header
Authorization: Bearer rv_live_...(API keys and scopes) - Required scope:
write:deals
openapi.json).Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (uuid) | yes | Resource id (UUID). |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
url | string (uri) | no | |
events | "deal.stage_changed" | "payment.received" | "document.signed" | "lead.created" | "shipment.updated"[] | no | |
enabled | boolean | no | true re-enables a subscription disabled after repeated failures. |
description | string | null | no |
Responses
200
The updated subscription.
application/json · Schema: Webhook
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
url | string | yes | |
description | string | null | yes | |
events | string[] | yes | |
enabled | boolean | yes | |
secretPrefix | string | null | yes | First characters of the signing secret, to tell secrets apart. The full secret is never shown again. |
failureCount | integer | yes | |
lastSuccessAt | string | null | yes | ISO 8601 date-time (UTC). |
lastFailureAt | string | null | yes | ISO 8601 date-time (UTC). |
400
Invalid request parameters or body (code validation_error).
application/problem+json · Schema: Problem
401
Missing, malformed, unknown, revoked or expired API key (code unauthorized).
application/problem+json · Schema: Problem
403
The API key lacks the scope required by this endpoint (code insufficient_scope).
application/problem+json · Schema: Problem
404
Not found in this tenant.
application/problem+json · Schema: Problem
422
The URL is not acceptable.
application/problem+json · Schema: Problem
429
Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.
application/problem+json · Schema: Problem