Skip to main content
Version: Latest

Webhook personalizado - Prueba

Permite disparar manualmente un envío de prueba al Webhook personalizado ya registrado por la empresa, con una guía y un estado dummy, para validar que su plataforma recibe y procesa correctamente la trama — sin necesidad de esperar el cambio de estado de una guía real.

Importante

Para usar este endpoint la empresa ya debe tener un Webhook personalizado registrado (ver Webhook personalizado API o el panel de Mis integraciones). Si no lo tiene, la respuesta es 404.

La trama que se envía tiene el mismo formato que una notificación real — ver Webhook estados de la guía — pero con datos de ejemplo (guia con prefijo TEST-) y no queda registrada en el histórico de envíos de la empresa.

Request​

url​

https://api.aveonline.co/api-webhook/public/api/v1/external/personalized-webhook/test

Method​

POST

Authorization: {token}
Accept: application/json
  • Authorization String Token de autenticación de AVEONLINE. De este token se identifica la empresa. El token se obtiene siguiendo la Autenticación.

No requiere body: la empresa se identifica automáticamente desde el token.

Response​

Success 200​

  • success Boolean Resultado de la operación.
  • message String Mensaje de respuesta.
  • data Object
    • companyId Number Id de la empresa identificada por el token.
    • webhookUrl String Url del Webhook personalizado a la que se envió la prueba.
    • trama Object Payload de ejemplo enviado a webhookUrl, con el mismo formato de [Webhook estados de la guía](./webhookEstadosGuias).
    • webhookResponse Object Respuesta que devolvió su propia plataforma al recibir la trama.
      • statusCode Number Código HTTP devuelto por su plataforma.
      • body Object Cuerpo de la respuesta devuelta por su plataforma.
    • test Boolean Siempre true, indica que es un envío de prueba.
{
  "success": true,
  "message": "Webhook de prueba enviado",
  "data": {
    "companyId": 25505,
    "webhookUrl": "https://midominio.com/mi-webhook",
    "trama": {
      "token": "x7Kp2mQ9rLtV4nB8wZ3cJ6yH1sD5fG0aE7uI2oP9kM4qR8tN3bX6vC1zW5lY0hT",
      "guia": "TEST-20260907153000",
      "pedido_id": "TEST-PEDIDO",
      "numeropedidoExterno": "TEST-EXTERNO",
      "estado": [
        {
          "estado_id": "0",
          "nombre_estado": "PRUEBA DE INTEGRACION",
          "fechacreacion": "2026-09-07 15:30:00",
          "fechanovedad": "",
          "comentarionovedad": "Este es un envio de prueba generado desde Mis integraciones para validar la conexion con tu plataforma.",
          "complementariosnovedad": "",
          "tiponovedad": ""
        }
      ],
      "guiadigitalizada": "",
      "fechaentrega": "2026-09-07 15:30:00"
    },
    "webhookResponse": {
      "statusCode": 200,
      "body": { "success": true, "messages": "Proceso realizado" }
    },
    "test": true
  }
}
tip

Lo que hay que validar es data.webhookResponse: es la respuesta real que devolvió su plataforma al recibir la trama de prueba. Si statusCode no es 2xx, o body no es el esperado, el problema está del lado de su integración — no del envío.

Errores​

Token no proporcionado o inválido 401​

{
  "status": "error",
  "message": "Token no proporcionado"
}

Webhook personalizado no registrado 404​

La empresa identificada por el token no tiene una integración CUSTOM registrada en Mis integraciones.

{
  "success": false,
  "message": "Webhook personalizado no registrado"
}

Webhook sin url configurada 422​

La integración existe, pero no tiene webhookUrl configurada.

No se pudo contactar su plataforma 502​

Timeout, DNS u otro error de red al intentar entregar la trama en webhookUrl.