POSThttps://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 entrega sintética al endpoint para comprobar que el receptor está en pie. Es el paso siguiente natural a registrar o actualizar un endpoint: confirma que responde 2xx y que valida la firma del cuerpo. Una prueba fallida no cuenta contra el endpoint. El contador de fallos consecutivos que acaba deshabilitándolo no se toca aquí, así que probar cuantas veces haga falta no acerca el endpoint a la desactivación automática. Antes de enviar nada se comprueba la dirección: un nombre que no resuelve responde 400 url_dns_failed, y una dirección que apunta a la red interna, 400 url_ssrf_blocked.

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

UUID del endpoint de webhook.

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 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.
CampoTipoDescripció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.

p. ej. true
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).

p. ej. 200
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.

p. ej. 184
errorstring | nullanulable

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

p. ej. Connection timed out after 10s
Códigos de respuestaPOST /v1/webhooks/{id}/test
CódigoClaseDescripciónCuerpo
2002xxResultado 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
4004xxLa dirección del endpoint no se pudo alcanzar o quedó bloqueada. El código es url_dns_failed cuando el nombre no resuelve, y url_ssrf_blocked cuando apunta a una dirección de red interna.ErrorResponse
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
400url_dns_failed

No se pudo resolver el nombre de la dirección.

Envelope
meta.request_id
a2b3c4d5e6f7
400url_ssrf_blocked

La dirección apunta a una red interna.

Envelope
meta.request_id
b3c4d5e6f7a8
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0
429rate_limit_exceeded

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

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`).