Llamar a un webhook desde un disparador
Nota: Este es un artículo de alto contenido técnico. Por ello, recomendamos involucrar 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 algo (por ejemplo, que se completó una orden de producto o que se ha reportado un problema), prefiera un disparador de webhook a 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 de integración más amplio con ERP, consulte Integración con ERP.
Este artículo explica cómo configurar un disparador Call a webhook: dónde configurarlo, qué atributos completar 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 Cómo 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.
Cómo añadir un disparador de webhook
- Haga clic en “Settings” en “Management”.
- Haga clic en “Triggers” en “Integrations”.
- Haga clic en “Add trigger” (el botón amarillo con el signo más).
- Rellene los campos descritos a continuación.
- Cuando haya terminado, haga clic en “Add”.
Qué, Cuándo y Alcance
- Qué: Seleccione “Call a webhook”.
- Cuándo: Seleccione el evento que debe activar el disparador (por ejemplo, cuando se completa una orden de producto o cuando se reporta un problema). Los eventos disponibles dependen del alcance.
- Alcance: Elija a qué se aplica el disparador — por ejemplo, una categoría de artículos, todas las órdenes de producto, incidencias, auditorías o un board. Los eventos disponibles dependen del alcance. 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 marcador de posición comienza 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: Solo se muestra cuando el método es POST. Introduzca aquí el contenido personalizado del cuerpo. La nota de la interfaz dice: “You can use parameters in this field.”
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:
| Alcance | Campos típicos |
|---|---|
| Órdenes de producto | identifier (número de orden de producto), y cuando proceda workinstructionId y recordingId |
| Incidencias | issueId, issueNumber (y para algunos eventos, campos relacionados con columna/acción) |
| Auditorías | 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 de la URL.
- POST: Los campos se envían como JSON en el cuerpo de la solicitud. Si configuró un Payload personalizado, ese contenido se anida bajo la clave
payloaden el cuerpo JSON (junto conapiKeyy los campos del 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 delante de un ERP.
Artículos relacionados
- ¿Qué es un disparador?
- Cómo editar y eliminar un disparador
- Cómo crear y gestionar claves API
- REST API de Azumuta
- Integración con ERP
Nota: El artículo 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 para configurar disparadores de webhook.