POST https://api.veriko.mx/v1/webhooks/{id}/test

Enviar evento de prueba al webhook

Audiencia
public
Autenticación
API key
Permiso
webhooks:create
Guía de uso →

Envía una notificación sintética de prueba al endpoint. Las entregas de prueba no incrementan el contador de fallos consecutivos usado para deshabilitar el endpoint automáticamente. Útil tras crear o actualizar un endpoint en POST /v1/webhooks para confirmar que el receptor responde 2xx y firma correctamente el cuerpo con HMAC-SHA256. El id es el UUID devuelto por el listado en GET /v1/webhooks.

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}/test' \
  -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 SendWebhookTestAttributes — Resultado inline del intento de entrega de prueba. `delivered=false` cuando la URL falla la revalidación SSRF (`error` contiene el detalle) o cuando el receptor respondió con un código fuera de 2xx.
Campo Tipo Descripción
delivered * boolean

`true` cuando el receptor respondió con un código `2xx` dentro del timeout. `false` cuando la URL falla la revalidación SSRF, el DNS no resuelve, el receptor agotó el timeout o respondió con un código fuera del rango `2xx`.

http_status * integer

Código HTTP que respondió el receptor. `0` cuando no hubo respuesta HTTP (DNS, timeout, fallo de revalidación SSRF antes de la conexión).

response_time_ms * integer

Tiempo total entre el inicio del intento de entrega y la respuesta (o el timeout) en milisegundos. Incluye DNS + TLS + roundtrip.

error string | null anulable

Detalle de la falla cuando `delivered=false`. `null` cuando la entrega fue exitosa.

Códigos de respuesta POST /v1/webhooks/{id}/test
Código Clase Descripción Cuerpo
200 2xx Resultado inline del intento de entrega de prueba. `delivered=false` cuando la URL falla la revalidación SSRF (`error` contiene el detalle) o cuando el receptor respondió con un código fuera de 2xx. 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}/test
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`).