v1

latestOpenAPI 3.0.32026-08-0425108247.7 KB
Webhooks

Rotate webhook endpoint secret

Rotates a webhook endpoint signing secret and returns the new secret exactly once.

post/webhook-endpoints/{endpointId}/rotate-secret

Path parameters

endpointIdstring required

Webhook endpoint identifier.

Webhook endpoint identifier.

Request body

previous_secret_ttl_secondsinteger

Seconds to keep the previous secret active. Maximum is 86400.

Response

Rotated webhook endpoint secret.

Example response

{
  "data": {
    "created_at": "2026-05-14T08:00:00.000Z",
    "delivery_scope": {
      "actor_workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
    },
    "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
    "updated_at": "2026-05-14T08:00:00.000Z",
    "workspace_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}