Skip to main content
Version: Latest

Webhook personalizado API

Permite registrar vía API el Webhook personalizado de la empresa, sin necesidad de hacerlo manualmente en el panel de Mis integraciones (https://guias.aveonline.co/panel/mis-integraciones).

Importante

La operación es idempotente: si la empresa aún no tiene un Webhook personalizado, se crea; si ya tiene uno, se actualiza con los datos enviados. La empresa se identifica automáticamente desde el token — no se envía en el payload.

Una vez registrado, AVEONLINE notificará cada cambio de estado de sus guías a la url configurada. Ver Webhook estados de la guía.

Request​

url​

https://api.aveonline.co/api-integrations/public/api/integrations/custom-webhook

Method​

POST

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

Params JSON​

  • name* String Nombre con el que se identifica la integración.
  • webhookUrl* String Url a la cual AVEONLINE enviará la trama de estados de las guías.
note

El token de la integración lo genera AVEONLINE automáticamente; no se envía en la petición. Se devuelve en la respuesta y se reenvía en cada notificación de estado para que su sistema valide que la petición es legítima.

Ejemplo​

{
  "name": "Webhook personalizado mi tienda",
  "webhookUrl": "https://midominio.com/mi-webhook"
}

Response​

Success — creado 201​

  • success Boolean Resultado de la operación.
  • message String Mensaje de respuesta.
  • data Object
    • id Number Id de la integración creada.
    • name String Nombre de la integración.
    • token String Token registrado.
    • type String Tipo de integración, siempre "CUSTOM".
    • webhookUrl String Url registrada.
    • companyId Number Id de la empresa identificada por el token.
    • createdAt String Fecha de creación.
    • updatedAt String Fecha de última actualización.
{
  "success": true,
  "data": {
    "id": 45,
    "name": "Webhook personalizado mi tienda",
    "token": "x7Kp2mQ9rLtV4nB8wZ3cJ6yH1sD5fG0aE7uI2oP9kM4qR8tN3bX6vC1zW5lY0hT",
    "type": "CUSTOM",
    "webhookUrl": "https://midominio.com/mi-webhook",
    "companyId": 25505,
    "createdBy": 9999,
    "createdAt": "2026-07-04T15:30:00.000000Z",
    "updatedAt": "2026-07-04T15:30:00.000000Z"
  },
  "message": "Custom webhook created successfully"
}

Success — actualizado 200​

Si la empresa ya tenía un Webhook personalizado, se actualiza y responde:

{
  "success": true,
  "data": {
    "id": 45,
    "name": "Webhook personalizado mi tienda",
    "token": "x7Kp2mQ9rLtV4nB8wZ3cJ6yH1sD5fG0aE7uI2oP9kM4qR8tN3bX6vC1zW5lY0hT",
    "type": "CUSTOM",
    "webhookUrl": "https://midominio.com/mi-webhook-v2",
    "companyId": 25505,
    "createdBy": 9999,
    "createdAt": "2026-07-04T15:30:00.000000Z",
    "updatedAt": "2026-07-04T16:10:00.000000Z"
  },
  "message": "Custom webhook updated successfully"
}

Errores​

Token no proporcionado o inválido 403​

{
  "success": false,
  "error": "Token not provided"
}
{
  "success": false,
  "error": "Invalid token provided"
}

Payload inválido 422​

{
  "success": false,
  "error": "Validation failed",
  "details": {
    "webhookUrl": ["The webhook url field must be a valid URL."]
  }
}