Llamar a un webhook desde un disparador
Nota: Este artículo es técnico, por lo que recomendamos involucrar a alguien con la experiencia técnica adecuada. Si tiene alguna pregunta, contáctenos en support@azumuta.com.
Cuando Azumuta necesita notificar a otro sistema que ha ocurrido algo (por ejemplo, se completó un pedido de producto o se informó de un problema), prefiera un disparador de webhook en lugar de sondear periódicamente la REST API. Los webhooks intercambian solo los datos necesarios en el momento en que ocurre el evento. Para el patrón más amplio de integración con ERP, vea Integración ERP.
Este artículo explica cómo configurar un disparador Call a webhook: dónde configurarlo, qué atributos rellenar y qué envía Azumuta a su endpoint.
Requisitos previos
Los disparadores de webhook incluyen una apiKey tomada de un Api Device en su espacio de trabajo. Necesita al menos un Api Device configurado. Si no existe ninguno, el webhook falla con un error como No api device configured.
Consulte Crear y gestionar claves API para ver cómo configurar un Api Device, y la REST API de Azumuta para saber cómo se usa esa clave al llamar de vuelta a Azumuta.
Añadir un disparador de webhook
- Haga clic en Configuración bajo Gestión.
- Haga clic en Disparadores bajo Integraciones.
- Haga clic en Añadir disparador (el botón amarillo con el símbolo +).
- Rellene los campos descritos a continuación.
- Cuando termine, haga clic en Añadir.
Qué, Cuándo y Ámbito
- Qué: Seleccione Call a webhook.
- Cuándo: Seleccione el evento que debe activar el disparador (por ejemplo, cuando se completa un pedido de producto o cuando se informa de un problema). Los eventos disponibles dependen del ámbito.
- Ámbito: Elija a qué se aplica el disparador — por ejemplo, una categoría de artículos, todos los pedidos de producto, incidencias, auditorías o un tablero. Los eventos disponibles dependen del ámbito. Vea:
Más adelante puede editar o eliminar el disparador y revisar el historial de uso.
Atributos
Después de seleccionar Qué y Cuándo, la sección Atributos muestra las opciones del webhook:
- Endpoint: La URL HTTPS que Azumuta llamará (el placeholder empieza con
https://). Este endpoint debe ser accesible desde los servidores de Azumuta. - Method: Botones de opción para GET o POST. El valor predeterminado es GET.
- Payload: Se muestra solo cuando el método es POST. Introduzca aquí el contenido personalizado del cuerpo. La nota de la interfaz dice: “Puede usar parámetros en este campo.”
Qué envía Azumuta
Azumuta siempre incluye una apiKey de un Api Device del espacio de trabajo, además de campos específicos del evento:
| Ámbito | Campos típicos |
|---|---|
| Pedidos de producto | identifier (número de pedido de producto), y cuando procede workinstructionId y recordingId |
| Incidencias | issueId, issueNumber (y, para algunos eventos, campos relacionados con la columna/acción) |
| Auditorías | recordingId, workinstructionId, y campos de auditoría relacionados como auditNumber |
La forma en que se entregan esos campos depende del método:
- GET: Los campos se añaden como parámetros de consulta de la URL.
- POST: Los campos se envían como JSON en el cuerpo de la petición. Si configuró un Payload personalizado, ese contenido se anida bajo la clave
payloaden el cuerpo JSON (junto con laapiKeyy los campos de evento mencionados arriba).
Su sistema receptor puede usar la apiKey incluida para llamar a la REST API de Azumuta y obtener datos adicionales cuando sea necesario — un patrón común con una capa de integración frente a un ERP.
Artículos relacionados
- Crear un disparador
- Editar o eliminar un disparador
- Crear y gestionar claves API
- REST API de Azumuta
- Integración ERP
Nota: El artículo de What’s New Configurable JSON Body When Using Webhooks anunció históricamente la función de cuerpo JSON configurable para POST. Esta página es la guía vigente para configurar disparadores de webhook.