Update an Endpoint receiver URL, description, subscribed events, or metadata.
Webhook is currently in Beta. APIs, fields, and behavior may change in future versions.
PUT /api/v1/forward/webhook/endpoints/{endpoint_id}
Only fields included in the request are updated. Omitted fields keep their current values.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or administrator SAT> |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
endpoint_id | string | Yes | Webhook Endpoint ID. |
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
url | string | No | New event receiver URL. HTTPS is recommended in production. |
description | string | No | New purpose description. |
events | string[] | No | Replaces the complete subscription list. Must contain at least one item. Accepts * or specific event names; prefix wildcards are not supported. See Supported public events for full event names and triggers. |
active | boolean | No | Whether the Endpoint is enabled. You can also use the dedicated enable or disable API. |
metadata | object | No | Merges custom metadata. Values are strings; pass null to remove a key. |
Example request
Example response
HTTP 200 OK
signing_secret.
Errors
| HTTP | Type | Trigger |
|---|---|---|
400 | invalid_request_error | The URL, event list, metadata, or request body is invalid. |
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The current token cannot manage Webhooks. |
404 | not_found_error | The Endpoint does not exist or is not visible to the current account. |
413 | invalid_request_error | The request body is too large. |
500/502/503 | api_error | The service is temporarily unavailable. |

