Ir al contenido principal

Webhooks: cómo funciona esta pantalla

Crea webhooks que envían eventos de QrX (pagos, envíos, devoluciones, almacén) a tu propio sistema, comprueba la firma, sigue cada entrega y arregla los endpoints que fallan.

H
Escrito por Hayko

Webhooks: cómo funciona esta pantalla

Los webhooks envían los eventos de QrX a tu propio sistema en el momento en que ocurren: un pago, un envío, una devolución, una lista de preparación y más. QrX envía un mensaje firmado a una dirección web (URL) que tú eliges. Esta guía explica la lista de webhooks y cada parte del editor de webhooks.

Qué ves en esta pantalla

  • Añadir (arriba a la derecha): crea un webhook nuevo.

  • Tarjetas de resumen: Ganchos web (todos los webhooks cargados), Activos, Inactivos y Requiere atención (webhooks que fallan o que se desactivaron automáticamente). Los números se basan en los webhooks cargados en la lista.

  • Buscar webhooks...: encuentra un webhook por nombre o URL.

  • Todos, Activos, Inactivos: muestra solo esos webhooks.

  • Actualizar (la flecha circular): vuelve a cargar la lista.

  • La lista de webhooks: carga más filas automáticamente al desplazarte. En una pantalla pequeña, desplaza la tabla hacia el lado para ver todas las columnas y acciones.

Las columnas

  • Nombre: el nombre que le diste al webhook, su URL y la versión de la API. Haz clic en el nombre para abrirlo. Haz clic en el título de la columna para ordenar por nombre.

  • Canal: Todos los Canales, o el único canal de venta al que se limita este webhook.

  • Eventos: cuántos eventos escucha el webhook, con los dos primeros nombres.

  • Estado: Activo, Desactivado (lo apagaste tú), Degradado (las entregas están fallando ahora), Desactivado automáticamente (QrX lo apagó tras 24 horas de fallos) o Fallando (varias entregas seguidas han fallado).

  • Entregados · 24 h y Fallidos · 24 h: entregas correctas y fallidas de las últimas 24 horas.

  • Actualizado: cuándo se cambió el webhook por última vez y la hora de la última entrega. Haz clic en el título de la columna para ordenar por fecha.

Acciones de cada fila

  • Reactivar la entrega (icono de encendido, solo en webhooks inactivos): vuelve a encender el webhook. Las entregas se reanudan de inmediato.

  • Editar (lápiz): abre el webhook.

  • Copiar: abre un webhook nuevo con el mismo nombre (más "copy"), eventos, canal, versión de API, campos del payload y destinatarios de alertas. La URL queda vacía para que escribas la nueva dirección. No se crea nada hasta que guardes.

  • Eliminar (papelera): te pide confirmación y luego elimina el webhook. Las entregas se detienen y no se puede deshacer.

Crear o editar un webhook

Haz clic en Añadir (o en un webhook de la lista). El menú de la izquierda también muestra cuántos eventos están activados, por ejemplo 3/33. El editor tiene una barra arriba y un menú a la izquierda (Endpoint, Eventos, Seguridad, Alertas, Entregas, Zona de peligro) para saltar a cada parte. Seguridad, Entregas y Zona de peligro aparecen cuando el webhook está guardado.

  • Cambios sin guardar o Todos los cambios guardados: indica si todavía tienes que guardar.

  • Guardar: guarda el webhook. También puedes pulsar Ctrl+S (Cmd+S en un Mac).

  • Cancelar: vuelve a la lista sin guardar.

  • Enviar Prueba (solo webhooks guardados): envía un evento de prueba a tu URL. Si el webhook escucha más de un evento, elige primero el evento de prueba en el campo de al lado. El resultado aparece en Entregas tras unos segundos. Los eventos de prueba se envían aunque el webhook esté apagado, así puedes comprobar tu endpoint antes de volver a encenderlo.

  • Copiar (solo webhooks guardados): crea un webhook nuevo a partir de este, igual que Copiar en la lista.

Debajo de la barra ves la URL (haz clic para copiarla), el estado, el canal, la versión de API, el número de eventos y la fecha de creación. En un webhook guardado ves también la salud de las entregas: Tasa de éxito, Latencia mediana (lo rápido que responde tu endpoint), Entregas · 24h y Fallidos · 24 h (con cuántos esperan un nuevo intento).

Si el webhook falla o está apagado, un banner de color explica el motivo. En un webhook apagado, haz clic en Reactivar en el banner para volver a activar las entregas.

Endpoint

  • Nombre (obligatorio): un nombre que reconozcas, por ejemplo "Mi integración".

  • URL del Endpoint (obligatorio): la dirección que recibe los mensajes. Debe empezar por https://. Cuando QrX ha entregado con éxito a esta URL, ves Verificado por entrega.

  • Canal: deja Todos los Canales o limita el webhook a un solo canal de venta.

  • Versión de API: el formato de mensaje que espera tu endpoint. La más reciente lleva la marca Última.

  • Activo: desactívalo para pausar las entregas sin eliminar el webhook. Los eventos que ocurren durante la pausa se omiten, no se envían más tarde.

Eventos

Elige qué eventos envían un mensaje. Los eventos están agrupados por tema, y los nombres de los grupos se muestran en tu idioma: Transacción, Envío, Pedido, Pago, Entrega, Devolución, Preparación, Entradas y Stock, además de los eventos de listas de preparación.

  • Haz clic en un evento para activarlo o desactivarlo. Usa Seleccionar todo o Deseleccionar todo en un grupo, y la flecha para abrir o cerrar un grupo.

  • Filtrar eventos…: escribe parte del nombre de un evento para encontrarlo.

  • El contador muestra cuántos de los eventos disponibles están activados, por ejemplo "3 / 33 eventos suscritos".

  • Personalizar payload (el icono de controles deslizantes junto a un evento activado): elige qué campos contiene el mensaje. Ves cada campo con su tipo, qué campos son Obligatorio (se envían siempre), un Payload de Ejemplo que puedes copiar, Seleccionar todo y Restablecer valores. Tu elección se aplica a todos los eventos del mismo grupo. Haz clic en Hecho para cerrar; la elección se guarda cuando guardas el webhook.

  • El grupo Stock tiene dos eventos: stock/adjusted (el stock de un artículo cambió en un almacén) y stock/low (un artículo bajó a su nivel de alerta de stock bajo o por debajo; se envía una vez por bajada). Cuando un socio de fulfillment tiene tu stock, recibes estos eventos para tus propios artículos, sin ubicaciones.

  • Los documentos de almacén tienen sus propios grupos: Recepciones (receipt/created, receipt/line_received, receipt/completed), Pedidos de compra (purchase_order/created, purchase_order/sent, purchase_order/received, purchase_order/closed), Recuentos (count/completed, count/approved), Contenedores (container/created, container/moved, container/emptied), Tareas de equipo (task/created, task/completed) y Traslados (transfer/sent, transfer/received, transfer/completed, transfer/cancelled: stock movido entre tus propios almacenes; transfer/received se envía en cada recepción y lista las líneas recibidas, y cada evento de traslado incluye el transportista y el seguimiento). Preparación también tiene picklist/assigned, picklist/cancelled, picklist/batch_created y fulfilment/snoozed (un pedido se pospuso o se quitó su aplazamiento). Estos eventos y los de Entradas no pertenecen a ningún canal de venta: cada webhook de tu cuenta que los seleccione los recibe, también un webhook limitado a un canal. Cada evento nuevo tiene un payload de ejemplo; ninguno contiene precios ni costes.

  • fulfilment/picked se envía una vez por pedido, cuando se completa en el teléfono la preparación de ese pedido.

  • El payload de ejemplo de los eventos de stock, de listas de preparación y de preparación muestra un ejemplo completo del mensaje, para que veas cada campo antes de crear tu integración.

Seguridad

  • Secreto de Firma: QrX firma cada mensaje con este secreto. Usa el icono del ojo para mostrarlo u ocultarlo y el icono de copiar para copiarlo.

  • Rotar…: crea un secreto nuevo. Todos los mensajes siguientes se firman de inmediato con el nuevo, así que actualiza primero el secreto en tu sistema.

  • Ejemplos de código (Node, C#, Python, PHP, cURL): muestran cómo tu sistema comprueba la firma.

  • Cabeceras de solicitud firmadas: cada mensaje lleva X-QrX-Signature (la firma del cuerpo del mensaje), X-QrX-Event (el nombre del evento) y X-QrX-Delivery-Id (un id único de la entrega).

Alertas (Notificaciones de fallo)

Haz clic en Añadir destinatario y elige compañeros de tu equipo. Reciben un correo cuando este webhook sigue fallando: un aviso tras 6 horas de fallos seguidos, y un mensaje cuando QrX apaga el webhook tras 24 horas. Haz clic en la X de un nombre para quitarlo. Guarda el webhook para conservar el cambio.

Entregas (Registros de Entrega)

Cada mensaje que QrX envió a este webhook, del más reciente al más antiguo. Las entregas nuevas aparecen solas mientras se muestra la etiqueta En vivo.

  • Buscar: encuentra entregas por ID de transacción, ID de pedido o evento.

  • Todos, Entregado, Fallido, Reintentando: muestra solo esas entregas.

  • 24h, 7d, 30d: el periodo del gráfico y de las tarjetas de salud de arriba.

  • Actualizar: vuelve a cargar las entregas.

  • Las columnas muestran el Estado, el Evento, el ID de Transacción, el Estado HTTP con el que respondió tu endpoint, la Duración, el número de Intento y cuándo fue Entregado. Si un mensaje se intentó más de una vez, haz clic en la flecha al inicio de la fila para ver cada intento.

  • Ver detalles de entrega (icono del ojo): muestra la solicitud y la respuesta completas, con el error si lo hay.

  • Reenviar: envía el mismo mensaje otra vez.

  • Cancelar entrega (solo mientras una entrega está en cola o reintentándose): detiene los intentos restantes.

Zona de peligro

  • Purgar historial de entregas: elimina para siempre las solicitudes y respuestas guardadas de este webhook. El webhook sigue funcionando.

  • Eliminar Webhook: detiene todas las entregas y elimina el webhook para siempre.

Ambas acciones piden confirmación primero y no se pueden deshacer.

Configura tu primer webhook

  1. Haz clic en Añadir.

  2. Escribe un Nombre y tu URL del Endpoint (https).

  3. Elige un Canal si el webhook es solo para un canal.

  4. Activa los Eventos que necesitas.

  5. Si quieres, añade compañeros en Alertas.

  6. Haz clic en Guardar. La sección Seguridad muestra ahora tu secreto de firma: añádelo a tu sistema para comprobar la firma.

  7. Haz clic en Enviar Prueba y revisa el resultado en Entregas.

Consejos y preguntas frecuentes

  • "El nombre es obligatorio", "La URL es obligatoria", "Selecciona al menos un evento": completa lo que falta y vuelve a guardar.

  • "Introduce una URL HTTPS válida (que empiece por https://).": la URL del Endpoint debe empezar por https://. Las direcciones http normales no se aceptan.

  • Otra persona cambió el webhook al mismo tiempo: QrX muestra un mensaje y te deja cargar de nuevo la última versión.

  • Mi webhook muestra Desactivado automáticamente: tu endpoint falló durante 24 horas seguidas. Arregla tu endpoint, compruébalo con Enviar Prueba y luego haz clic en Reactivar. Los eventos del periodo en que estuvo apagado no se envían automáticamente después; usa Reenviar en una entrega si la necesitas de nuevo.

  • ¿Cómo sé que un mensaje viene realmente de QrX? Calcula el HMAC-SHA256 del cuerpo sin procesar del mensaje con tu secreto de firma y compáralo con la cabecera X-QrX-Signature. La sección Seguridad tiene ejemplos listos para usar.

  • ¿Necesitas ayuda? Haz clic en Chat en la parte inferior del Centro de ayuda.

¿Ha quedado contestada tu pregunta?