POST/v1/webhooks/{id}/rotate

Create webhooks id rotate

Mint a fresh signing secret for one subscription and answer it in full — the second and last place a secret leaves this service. The previous secret stopped verifying the moment this returned, so the receiver has to be updated before the next event reaches it. 503 when the service has no field key. Admin only.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "note": "string",
    "secret": "string",
    "webhook": {
      "authHeaderName": "string",
      "authKind": "string",
      "createdAt": "string",
      "createdBy": 1,
      "description": "string",
      "events": [
        "string"
      ],
      "id": "",
      "name": "string",
      "secretHint": "string",
      "secretRotatedAt": "string",
      "status": "string",
      "updatedAt": "string",
      "url": "string"
    }
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired