Llamar a un webhook desde un disparador
Nota: Este es un artículo de carácter altamente técnico. Por ello, le recomendamos que involucre a su departamento de TI al leerlo. Si tiene alguna consulta o solicitud, póngase en contacto con nosotros a través de support@azumuta.com; estaremos encantados de ayudarle.
Cuando Azumuta necesita notificar a otro sistema que ha ocurrido un evento (por ejemplo, que se completó una orden de producto o se reportó un problema), prefiera un webhook trigger en lugar de sondear periódicamente la REST API. Los webhooks intercambian únicamente los datos necesarios en el momento en que ocurre el evento. Para el patrón de integración con ERP más amplio, consulte ERP Integration.
Este artículo explica cómo configurar un trigger Call a webhook: dónde configurarlo, qué atributos rellenar y qué envía Azumuta a su endpoint.
Prerequisites
Los webhook triggers incluyen un apiKey tomado 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 Create and manage API keys para saber cómo configurar un Api Device, y la REST API de Azumuta para entender cómo se utiliza esa clave al llamar de vuelta a Azumuta.
Add a webhook trigger
- Haga clic en Settings bajo Management.
- Haga clic en Triggers bajo Integrations.
- Haga clic en Add trigger (el botón amarillo con el signo más).
- Rellene los campos descritos más abajo.
- Cuando termine, haga clic en Add.
What, When, and Scope
- What: Seleccione Call a webhook.
- When: Seleccione el evento que debe activar el trigger (por ejemplo, cuando se completa una orden de producto o cuando se reporta un problema). Los eventos disponibles dependen del scope.
- Scope: Elija a qué se aplica el trigger: por ejemplo, a una categoría de artículos, a todas las órdenes de producto, a problemas, a auditorías o a un board. Los eventos disponibles dependen del scope. Consulte:
Más adelante puede editar o eliminar el trigger y revisar el historial de uso.
Attributes
Después de seleccionar What y When, la sección Attributes mostrará las opciones del webhook:
- Endpoint: La URL HTTPS que Azumuta llamará (el marcador de posición empieza con
https://). Este endpoint debe ser accesible desde los servidores de Azumuta. - Method: Botones de opción para GET o POST. El valor por defecto es GET.
- Payload: Se muestra solo cuando el método es POST. Introduzca aquí el contenido personalizado del cuerpo. La nota de la interfaz indica: “You can use parameters in this field.”
What Azumuta Sends
Azumuta siempre incluye un apiKey de un Api Device del espacio de trabajo, además de campos específicos del evento:
| Scope | Typical fields |
|---|---|
| Product orders | identifier (número de orden de producto), y cuando procede workinstructionId y recordingId |
| Issues | issueId, issueNumber (y para algunos eventos, campos relacionados con columna/acción) |
| Audits | recordingId, workinstructionId, y campos de auditoría relacionados como auditNumber |
Cómo se entregan esos campos depende del método:
- GET: Los campos se añaden como parámetros de consulta en la URL.
- POST: Los campos se envían como JSON en el cuerpo de la petición. Si ha configurado un Payload personalizado, ese contenido se anida bajo la clave
payloaden el cuerpo JSON (junto aapiKeyy los campos del evento mencionados arriba).
Su sistema receptor puede utilizar el apiKey incluido para llamar a la REST API de Azumuta y obtener datos adicionales cuando sea necesario; es un patrón habitual usar una capa de integración delante de un ERP.
Related Articles
- What Is a Trigger?
- Edit and delete a trigger
- Create and manage API keys
- Azumuta’s REST API
- ERP Integration
Nota: El artículo de What’s New Configurable JSON Body When Using Webhooks anunció históricamente la función de payload en POST. Esta página es la guía actual sobre cómo configurar triggers de webhook.