POST https://api.veriko.mx/v1/webhooks/{id}/regenerate-secret

Regenerar el secret de firma del webhook

Audiencia
public
Permiso
webhooks:update
Guía de uso →

Rota el secret de firma HMAC-SHA256 del endpoint. El nuevo secret se devuelve una única vez en esta respuesta — el anterior queda invalidado inmediatamente. Almacénalo de forma segura.

Parámetros
Parámetro Ubicación Tipo Obligatorio Descripción
id * path string (uuid) obligatorio

UUID del endpoint de webhook.

Petición
curl -X POST 'https://api.veriko.mx/v1/webhooks/{id}/regenerate-secret' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200 WebhookEndpoint — Lista de endpoints de webhook del usuario con su estado y eventos.
Campo Tipo Descripción
type * string

id * string (uuid)

Identificador del endpoint.

attributes * object

Atributos canónicos del endpoint de webhook (URL receptora, eventos suscritos, estado y secreto).

url string (uri)

URL HTTPS receptora. En producción se rechaza HTTP, URLs que resuelven a IPs privadas (SSRF), y URLs `>2048` caracteres.

events array

Lista de eventos suscritos. Máximo 10.

description string | null anulable

Etiqueta libre del endpoint.

status string

`active` recibe entregas. `disabled` fue apagado manualmente. `auto_disabled` fue desactivado por la plataforma tras superar `webhooks.auto_disable_threshold` fallos consecutivos.

consecutive_failures integer

Contador de fallos consecutivos. Se resetea en éxito.

last_delivery_at union

Marca de tiempo UTC del último intento de entrega (cualquier status). `null` cuando el endpoint aún no recibió ningún delivery.

secret string

Clave compartida para verificar firmas. **Solo presente** en la respuesta de creación y regeneración del endpoint; se omite en cualquier otra respuesta.

secret_hint string

Últimos 4 caracteres del secret, prefijados con `...`. Presente en cualquier respuesta donde `secret` está oculto.

created_at string (date-time)

Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.

updated_at string (date-time)

Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.

Códigos de respuesta POST /v1/webhooks/{id}/regenerate-secret
Código Clase Descripción Cuerpo
200 2xx Nuevo secret generado. Solo se devuelve en esta respuesta. Sin cuerpo
401 4xx Se requiere autenticación o las credenciales son inválidas ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
404 4xx `not_found` — el endpoint no existe o no pertenece al usuario. ErrorResponse
429 4xx Límite de tasa excedido ErrorResponse
Errores de POST /v1/webhooks/{id}/regenerate-secret
Código Clave Detalle
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
429 rate_limit_exceeded

Rate limit exceeded. Try again in 45 seconds.

Envelope
meta.request_id
f7a8b9c0d1e2
Cabeceras de respuesta
  • Retry-After : integer — Segundos a esperar antes de reintentar. Coincide con la ventana de rate-limit del endpoint (típicamente 60s para listas, 1-5s para operaciones idempotentes en vuelo).
  • X-RateLimit-Limit : integer — Límite de solicitudes configurado para este bucket (emitido sólo en 429).
  • X-RateLimit-Remaining : integer — Solicitudes restantes en la ventana actual — siempre 0 en el momento del 429 (emitido sólo en 429).
  • X-RateLimit-Reset : integer — Unix epoch absoluto (segundos) en que se reinicia la ventana. Emitido sólo en 429, junto con Retry-After. Puede existir sobreescritura por endpoint (p. ej. `rate_limited_login`).