Rotate webhook secret
Generates a new signing secret for one webhook subscription. Store the returned plaintext secret immediately because later reads show only secret_preview.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Path Params
idstring
Webhook subscription ID.
Response Body
200
idstring
Webhook subscription ID.
namestring
Human-readable webhook label.
secretstring
New plaintext signing secret. Returned only in this rotate response.
secret_previewstring
Short preview of the new secret.
eventsstring[]
Current subscribed events.
activeboolean
Current active state.
401
error.codestring
Usually "NOT_FOUND" or "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "not_found" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
404
error.codestring
Usually "NOT_FOUND" or "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "not_found" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Usually "NOT_FOUND" or "UNAUTHORIZED".
error.normalized_codestring
Lowercase alias such as "not_found" or "unauthorized".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.