Sign in
Management

Roll webhook secret

Changed on

Rotate a webhook signing secret and return the new secret. The previous secret remains valid for 24 hours. Returns 404 if the project or webhook does not exist. This endpoint requires the write:all scope.

post/management/projects/{projectId}/webhooks/{webhookId}/secret/roll

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/management/projects/{projectId}/webhooks/{webhookId}/secret/roll
  • Auth: none declared

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13
webhookIdstring required

ID of the webhook

Example:wh_abc123

Response

Success. Returns the rotated secret key.

messagestring required

Example response

{
  "secret": {
    "value": "whsec_new_abc123"
  },
  "message": "Previous secret remains valid for 24 hours."
}

Changes