Un Webhook es una notificación enviada a una URL de tu elección cada vez que ocurre un evento determinado.
Los webhooks son útiles para la integración con servicios de terceros y otras APIs externas que los soportan.
Qapla’ dispone de dos tipos de webhook:
Para poder utilizar las API, es necesario conocer las Claves API Privadas asignadas a tu(s) canal(es), disponibles en el Panel de Control en la sección:
Configuración > Canales [Nombre del canal] > Configurar > Canal > Clave API Privada
Atención: la Clave API Privada debe ser protegida y mantenida en secreto.
Shipments Webhook (notificación tracking envíos)
Shipments Webhook permite recibir una notificación POST en formato JSON cada vez que el transportista comunica un cambio de estado, por ejemplo cuando el envío pasa de “en reparto” a “entregado”.
Para configurar el webhook de notificación tracking de envíos, accede a:
Configuración > Canales [Nombre del canal] > Configurar > Actualizaciones > Webhook > Webhook de notificación tracking envíos
Configura los siguientes parámetros:
- Activación: marca la opción “Activar” para habilitar
- URL: introduce la URL de destino
- Versión: selecciona la versión:
- 1.2 versión clásica
- 1.3 versión recomendada, actualizada para incluir también información sobre productos, bultos y destinatario
Shipments Return Webhook
En el caso de devoluciones gestionadas a través del servicio Devoluciones automáticas (Tipo 3, requiere compra y activación), se enviará una notificación POST en formato JSON cada vez que un cliente final solicite una devolución, incluyendo los detalles del envío de retorno.
Información adicional
El webhook de notificación tracking de envíos se envía cuando:
- Está activado en la configuración.
- El envío cambia de estado, por ejemplo, de “en reparto” a “entregado”.
El trigger es el cambio de estado comunicado por el transportista.
Puedes consultar el historial de envíos del webhook directamente en Qapla’, en la sección Tracking, selecciona el envío y haz clic en Webhook.
Test
Se recomienda probar el endpoint utilizando la herramienta específica de prueba: Test de webhook de envíos
Orders Webhook (notificación creación de envíos)
Permite recibir una notificación POST en formato JSON en los siguientes casos:
- En la creación: cuando se genera el pedido (el pedido pasa de la fase “Crear” a “Imprimir”, generando así el envío)
- En la transmisión: cuando se realiza la transmisión de los envíos generados (fase “Transmitir”, última fase, en la que los datos se envían al transportista)
Para configurar el webhook de notificación de generación de envíos, accede a:
Configuración > Canales [Nombre del canal] > Configurar > Actualizaciones > Webhook > Webhook de notificación creación de envíos
Configura los siguientes campos:
- Activación: marca la opción “Activar” para habilitar
- URL: introduce la URL de destino
- Evento: selecciona el tipo de evento:
- En la creación
- En la transmisión
Información adicional
Este webhook no está disponible para quienes generan envíos a través de la API (createLabel y confirmLabel).
Está destinado únicamente a quienes generan los envíos mediante el Panel de Control de Qapla’ (fases Crear, Imprimir y Transmitir).
El webhook de generación de envíos se envía cuando:
- Está activado en la configuración.
- Se produce el evento seleccionado en la configuración.
El triger es el evento configurado, ya sea la creación o la transmisión del envío.
Test
Se recomienda probar el endpoint utilizando la herramienta específica de prueba: Orders Webhook Test