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

Enviar evento de prueba al endpoint webhook

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

Envía una entrega sintética al endpoint webhook para comprobar que el receptor está en pie.

Se recomienda ejecutar al registrar o actualizar un endpoint webhook: confirma que responde con un estado HTTP 2xx y que valida la firma del cuerpo.

Antes de enviar, se vuelve a comprobar la URL. Un nombre que no resuelve, o una URL que no es pública, dejaría el resultado con delivered=false y el detalle en error.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
id*pathstring (uuid)obligatorio

Identificador único del endpoint webhook (UUID v4).

p. ej. f47ac10b-58cc-4372-a567-0e02b2c3d479
Petición
curl -X POST 'https://api.veriko.mx/v1/webhooks/{id}/test' \
  -H 'Authorization: Bearer veriko_••••' \
  -H 'Content-Type: application/json'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200SendWebhookTestAttributes — Resultado del intento de entrega de prueba. `delivered=false` cuando la URL falla la validación URL o cuando el receptor respondió con un código fuera de `2xx`. (`error` contiene el detalle si aplica).
CampoTipoDescripción
delivered*boolean

true cuando el endpoint webhook receptor respondió con un estado HTTP 2xx y dentro del tiempo de espera. false cuando falla la validación URL, el DNS no resuelve, se agotó el tiempo de espera o respondió con un código fuera del rango 2xx.

p. ej. true
http_status*integer

Código de estado HTTP con el que respondió el endpoint webhook receptor. 0 cuando no hubo respuesta HTTP: DNS, tiempo agotado, o el fallo de la re-validación SSRF antes de la conexión.

p. ej. 200
response_time_ms*integer

Duración del intento de entrega, en milisegundos. Incluye DNS, TLS y el viaje de ida y vuelta.

p. ej. 184
error*string | nullanulable

Detalle del fallo de transporte o de validación de URL. Puede ser null aunque delivered=false si el receptor respondió con un estado fuera de 2xx pero la petición se completó.

p. ej. Connection timed out after 10s
Códigos de respuestaPOST /v1/webhooks/{id}/test
CódigoClaseDescripciónCuerpo
2002xxResultado del intento de entrega de prueba. delivered=false cuando la URL falla la validación URL o cuando el receptor respondió con un código fuera de 2xx. (error contiene el detalle si aplica).SendWebhookTestAttributes
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4044xxnot_found: El endpoint no existe o no pertenece al usuario.ErrorResponse
4294xxLímite de tasa excedidoErrorResponse
Errores de POST /v1/webhooks/{id}/test
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d
429rate_limit_exceeded

Límite de peticiones excedido. Inténtalo de nuevo en 45 segundos.

Envelope
meta.request_id
f7a8b9c0d1e22e1d0c9b8a7f
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. Se emite en cada 429 y, en la API autenticada, también en las respuestas correctas, donde es el tope por clave del plan de la cuenta.
  • X-RateLimit-Remaining: integer — Solicitudes restantes en la ventana actual. Siempre 0 en el momento del 429; en una respuesta correcta de la API autenticada es lo que queda del tope por clave.
  • X-RateLimit-Reset: integer — Unix epoch absoluto (segundos) en que se reinicia la ventana. Se emite en cada 429, junto con Retry-After, y en las respuestas correctas de la API autenticada. Puede existir sobreescritura por endpoint (p. ej. `rate_limited_login`).