Update webhook
Updates the webhook name, destination URL, event list, or active state for an existing subscription. This endpoint cannot change the signing secret.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Path Params
idstring
Webhook subscription ID.
Request Body
name?string
Update the human-readable webhook label.
url?string
Replace the destination URL.
events?string[]
Replace the subscribed event list.
active?boolean
Enable or disable delivery without deleting the webhook.
Response Body
200
idstring
Webhook subscription ID.
urlstring
Updated destination URL.
eventsstring[]
Updated event list.
activeboolean
Updated active state.
secret_previewstring
Preview of the existing secret.
401
error.codestring
Usually "NOT_FOUND", "UNAUTHORIZED", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase alias such as "not_found", "unauthorized", or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
404
error.codestring
Usually "NOT_FOUND", "UNAUTHORIZED", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase alias such as "not_found", "unauthorized", or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
422
error.codestring
Usually "NOT_FOUND", "UNAUTHORIZED", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase alias such as "not_found", "unauthorized", or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Usually "NOT_FOUND", "UNAUTHORIZED", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase alias such as "not_found", "unauthorized", or "validation_error".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.