https://api.veriko.mx/v1/webhooks/{id}/regenerate-secretRegenerar la firma secreta de un endpoint webhook
Guía de uso →Rota el secreto con el que se firman las entregas de un endpoint webhook. El secreto nuevo viaja una sola vez, en esta respuesta, y no hay forma de volver a consultarlo.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | string (uuid) | obligatorio | Identificador único del endpoint webhook (UUID v4). p. ej.f47ac10b-58cc-4372-a567-0e02b2c3d479 |
curl -X POST 'https://api.veriko.mx/v1/webhooks/{id}/regenerate-secret' \
-H 'Authorization: Bearer veriko_••••' \
-H 'Content-Type: application/json'Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
type* | string | Tipo de recurso JSON:API. Siempre webhook_endpoint |
id* | string (uuid) | Identificador único del endpoint webhook (UUID v4). p. ej.a1b2c3d4-e5f6-7890-abcd-ef0123456789 |
attributes* | object | Datos del endpoint webhook (URL receptora, eventos suscritos, estado y secreto). |
url* | string (uri) | URL receptora del webhook. En producción se rechaza si no usa HTTPS, si resuelve a una dirección privada o si pasa de 2048 caracteres. p. ej.https://example.com/webhooks/entregas |
events* | array (elementos: 1–10, elementos únicos) | Eventos a los que se suscribe el endpoint webhook. Entre 1 y 10. |
description* | string | nullanulable | Etiqueta libre para distinguir el endpoint webhook de los demás. p. ej.Alta de pagos en el ERP |
status* | string | Estado actual del webhook — active |
consecutive_failures* | integer | Cantidad de fallos consecutivos. Se reinicia al primer éxito. p. ej.0 |
last_delivery_at* | TimestampUTC | null | Fecha y hora de la última entrega exitosa, en ISO 8601 UTC. |
secret | string | Clave compartida para verificar firmas. Solo presente en la respuesta de creación y de rotación del endpoint; se omite en cualquier otra respuesta. Se usa para validar las cabeceras a0b1c2d3e4f5061728394a5b6c7d8e9f00112233445566778899aabbccddeeff |
secret_hint | string | Últimos 4 caracteres del secret, con el prefijo ...4f2a |
created_at* | string (date-time) | Timestamp ISO 8601 en UTC con sufijo 2026-05-01T05:14:38Z |
updated_at* | string (date-time) | Timestamp ISO 8601 en UTC con sufijo 2026-05-01T05:14:38Z |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Nuevo secret generado. Solo se devuelve en esta respuesta. | WebhookEndpoint |
| 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 |
| Código | Clave | Ejemplo |
|---|---|---|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|
| 403 | permission_denied | No tienes permiso para acceder a este recurso. Envelope
|
| 429 | rate_limit_exceeded | Límite de peticiones excedido. Inténtalo de nuevo en 45 segundos. Envelope
Cabeceras de respuesta
|