Rotar el secreto de firma de un endpoint de webhook

POST /v1/webhook-endpoints/{endpoint_id}:rotate-secret · permiso webhook-endpoints:write · todos los planes

Emite un nuevo secreto de firma y lo devuelve una sola vez (Cache-Control: no-store). Durante previous_secret_ttl_hours (por defecto 24) cada entrega incluye dos firmas en el encabezado webhook-signature, una con el secreto anterior y otra con el nuevo, de modo que puede cambiar su receptor sin perder entregas. 0 elimina el secreto anterior de inmediato (para un secreto filtrado). Una solicitud repetida con el mismo Idempotency-Key devuelve el endpoint sin el secreto y con secret_redacted: true.

Solicitud

Campo	Tipo	Obligatorio	Descripción
`endpoint_id`	ruta	sí	ID del endpoint de webhook (`whe_…`).
`If-Match`	encabezado	no	Si se indica, debe coincidir con el `ETag` actual del endpoint.
`previous_secret_ttl_hours`	entero	no	De 0 a 168 horas durante las que el secreto anterior sigue firmando; por defecto 24. El cuerpo es opcional.
`Idempotency-Key`	encabezado	no	Reproduce la respuesta (sin el secreto) para una solicitud repetida con la misma clave.

{
  "previous_secret_ttl_hours": 24
}

Respuesta

200 OK con el endpoint, su nuevo ETag y el nuevo secreto.

{
  "id": "whe_01k8a3m5q7t9v1w3x5y7z9b2c4",
  "key": "crm-sync",
  "url": "https://hooks.example.com/keenauth",
  "description": "CRM sync",
  "event_types": ["user.created", "user.updated"],
  "event_schema_versions": {},
  "payload_mode": "thin",
  "status": "enabled",
  "rate_limit_per_second": 50,
  "previous_secret_expires_at": "2026-10-27T10:00:00Z",
  "last_success_at": "2026-10-26T09:12:00Z",
  "failing_since": null,
  "version": 4,
  "created_at": "2026-10-26T09:00:00Z",
  "updated_at": "2026-10-26T10:00:00Z",
  "signing_secret": "idp_whsec_<secret>"
}

Errores

HTTP	código	Cuándo
400	`unknown_field`	El cuerpo tiene un campo que no aparece en la lista anterior.
404	`not_found`	No existe ese endpoint en este entorno.
412	`precondition_failed`	`If-Match` no coincide con la versión actual.
422	`validation_failed`	`/previous_secret_ttl_hours out_of_range`: no está entre 0 y 168.
422	`idempotency_key_reuse`	La `Idempotency-Key` se usó con una solicitud distinta.
401	`unauthenticated`	La credencial falta, no es válida o fue revocada.
403	`insufficient_permissions`	La credencial no tiene el permiso `webhook-endpoints:write`.
503	`service_unavailable`	La administración de webhooks no está disponible temporalmente; reintente después del período indicado en `Retry-After`.

Ejemplo

curl -X POST https://api.eu.keenauth.com/v1/webhook-endpoints/whe_01k8a3m5q7t9v1w3x5y7z9b2c4:rotate-secret \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 4c6e8a0b-2d4f-4a6c-9e1b-3d5f7a9c1e3b" \
  -d '{"previous_secret_ttl_hours":24}'

CLI: keenauth webhook-endpoints rotate-secret whe_01k8a3m5q7t9v1w3x5y7z9b2c4 --previous-secret-ttl-hours 24