Saltar al contenido principal
GET
/
api
/
v1
/
webhook
/
test
Probar la entrega del webhook
curl --request GET \
  --url https://api.benzinga.com/api/v1/webhook/test \
  --header 'Key: <api-key>'
{
  "status": "success"
}

​
Descripción general

Use este endpoint para activar el envío de un webhook de prueba a su endpoint configurado. Esto le permite verificar que su integración de webhook esté funcionando correctamente antes de recibir datos de producción en tiempo real.

​
Probar tu integración

Cuando invoques este endpoint, Benzinga enviará un payload de webhook de prueba a la URL de destination que hayas configurado. Esta entrega de prueba sigue el mismo formato y la misma lógica de reintentos que las entregas de webhooks en producción.

​
Qué esperar

  1. Respuesta inmediata: La API devuelve un código de estado 200 si la entrega de prueba se activó correctamente.
  2. Payload de prueba: Tu endpoint de webhook recibe un payload de prueba con el mismo formato que los datos de producción.
  3. Encabezados de entrega: La entrega de prueba incluye el encabezado X-BZ-Delivery, igual que las entregas de producción.

​
Verifica tu integración

Usa este endpoint para confirmar lo siguiente:
  • Que tu endpoint de webhook sea públicamente accesible
  • Que tu endpoint pueda analizar correctamente el formato del payload del webhook
  • Que tu endpoint responda con los códigos de estado apropiados (2xx para una respuesta satisfactoria)
  • Que tu endpoint responda dentro del tiempo de espera de 30 segundos
  • Que tu lógica de idempotencia maneje correctamente el encabezado X-BZ-Delivery y el campo id del payload

​
Mejores prácticas

  • Prueba primero con endpoints de webhook que no sean de producción
  • Verifica que tu endpoint responda con los códigos de estado 200 o 204
  • Confirma que tu registro y monitoreo capturen la entrega de prueba
  • Comprueba que tu lógica de desduplicación funcione con el ID de entrega de prueba
  • Prueba escenarios de error devolviendo temporalmente códigos de estado de error

​
Solución de problemas

​
424 Error de entrega

Si recibes un código de estado 424, el sistema no pudo entregar la carga de prueba a tu endpoint de destino. Causas habituales:
  • La URL de destino no es accesible públicamente
  • El endpoint de destino está devolviendo códigos de estado de error
  • Problemas de conectividad de red
  • Errores de certificado SSL/TLS en el endpoint de destino

​
400 Solicitud no válida

Asegúrate de que todos los parámetros obligatorios se hayan proporcionado y tengan el formato correcto:
  • destination debe ser una URL HTTPS válida
  • version debe ser webhook/v1
  • kind debe ser News/v1
{
  "status": "success"
}

Autorizaciones

​
Key
string
header
requerido

Tu clave de la API de Benzinga

Parámetros de consulta

​
destination
string<uri>
requerido

La URL del endpoint de webhook al que se enviarán los datos de prueba

​
version
enum<string>
predeterminado:webhook/v1
requerido

Versión de la API, actualmente webhook/v1

Opciones disponibles:
webhook/v1
​
kind
enum<string>
predeterminado:News/v1
requerido

Identifica el kind de mensaje para un payload de prueba

Opciones disponibles:
News/v1,
Signals/v1,
Earnings/v1,
Ratings/v1,
Dividends/v1,
IPOs/v1,
Guidance/v1,
Splits/v1,
OptionActivity/v1,
Conference/v1,
Economics/v1,
Offerings/v1,
MA/v1,
Retail/v1,
FDA/v1,
WIIMs/v1,
SECInsiderTransaction/v1,
GovernmentTrade/v1
​
token
string

Indique el token para transformar los datos para su uso en producción

Respuesta

Éxito - La entrega de prueba del webhook se envió correctamente

​
status
string
Ejemplo:

"success"