For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Cómo configurar webhooks en VergeOS para mensajería push a sistemas externos, incluida la creación de webhooks, la configuración de la carga útil de la tarea y la configuración de desencadenadores de eventos.

Los webhooks permiten mensajería basada en push a sistemas externos cuando ocurren eventos específicos. Cuando se produce un evento desencadenante, un webhook envía una solicitud HTTP (normalmente un POST) a una URL predefinida. Este mecanismo de push es más eficiente que la sondeo tanto para notificaciones como para la automatización de flujos de trabajo, ya que el sistema receptor no necesita comprobar periódicamente si hay actualizaciones.

Ejemplos de uso de webhooks

Los webhooks de VergeOS permiten una alta configurabilidad para la comunicación impulsada por eventos con sistemas de terceros, ofreciendo una amplia variedad de oportunidades de optimización. Los siguientes ejemplos básicos demuestran posibles alertas y automatización de flujos de trabajo mediante webhooks:

  • Enviar una notificación de Slack a un canal de administradores cuando un trabajo de sincronización produzca un error

  • Publicar en un sistema de contabilidad cuando un inquilino de VergeOS se conecte, activando un cargo automático

  • Activar un flujo de trabajo de Zapier cuando una VM específica se encienda, iniciando acciones entre aplicaciones (p. ej., informes, correo electrónico, notificaciones, etc.)

Pasos de configuración

Para poner un webhook en acción, siga estos pasos:

  • Crear un webhook: define la URL de destino, el método de autenticación y cualquier encabezado personalizado requerido por el sistema externo

  • Crear una tarea: define la carga útil que se entregará

  • Crear un evento: designa un acontecimiento que activará la tarea

Crear un webhook

  1. Vaya a Sistema > Panel de tareas.

  2. Haga clic en Nuevo webhook en el menú de la izquierda.

  3. Configurar webhook:

  • Nombre: Proporcione un nombre descriptivo para el webhook.

  • URL: Introduzca el punto final de la API expuesto por el sistema de destino para aceptar solicitudes HTTP POST.

De forma predeterminada, se incluye un encabezado para especificar una carga útil content-type: application/json. Este encabezado puede eliminarse o editarse según sea necesario, y pueden configurarse encabezados adicionales según se requiera o se admitan en el sistema de destino (p. ej., cambiar el tipo de contenido, el enrutamiento de eventos, el límite de velocidad, la prioridad, etc.) - Para cambiar el orden de los encabezados personalizados: seleccione la casilla de verificación de los encabezados deseados y use los botones de flecha Arriba/Abajo - Use el botón Más para agregar encabezados adicionales - El botón del lápiz alterna entre la entrada de pares clave/valor de encabezado y la entrada manual de la sintaxis completa del encabezado

  • Permitir certificados inseguros: Esta opción está destinada a admitir certificados autofirmados para entornos de prueba/desarrollo. Utilizar certificados inseguros para sistemas y datos de producción (en particular, URL públicas) es arriesgado y no se recomienda.

  • Tiempo de espera agotado: Define el número máximo de segundos a esperar una respuesta del sistema de destino (debe ser 3 o mayor)

  • Reintentos: Número de reintentos a realizar cuando no se reciba respuesta o se devuelva un error del sistema de destino

  1. Haga clic en Enviar para guardar el webhook.

Crear una tarea

  1. Vaya a Sistema > Panel de tareas.

  2. Haga clic en Nueva tarea en el menú de la izquierda.

  3. Configurar tarea:

    • Nombre: Proporcione un nombre descriptivo para la tarea.

    • Descripción(opcional): Se puede almacenar información adicional para la tarea, por ejemplo, su propósito, resultado esperado, etc.

    • Eliminar tarea después de ejecutarse: defina una activación única; el sistema eliminará automáticamente la tarea después de que se haya ejecutado una vez.

    • Tipo de objeto: Webhook

    • Objeto: Seleccione el webhook creado en el paso anterior.

    • Acción: Enviar

    • Mensaje: Defina la carga útil que se enviará al sistema externo. - La carga útil predeterminada incluye un par clave-valor básico con la cadena "Webhook" como valor; elimínelo o modifíquelo según sea necesario para crear la carga útil deseada.

  1. Haga clic en Enviar para guardar la tarea.

Crear un evento

  1. Vaya a Sistema > Panel de tareas.

  2. Haga clic en Nuevo evento en el menú de la izquierda.

  3. Configurar evento:

    • Tipo: Seleccione el área correspondiente del sistema VergeOS donde se producirá el desencadenante.

    • Evento: La lista de eventos cambiará según el tipo seleccionado arriba. Seleccione el evento deseado que servirá como desencadenante.

    • Seleccione una instancia específica del objeto o una etiqueta para desencadenar el evento: (Algunos tipos seleccionados, como Alarmas se aplican a nivel general y no ofrecen opciones para etiquetas ni objetos específicos.)

      • Seleccione una instancia específica del tipo de objeto en la lista desplegable (Por ejemplo, si "Usuarios" es el tipo seleccionado, elija un usuario concreto de la Usuario lista desplegable; si "Máquinas virtuales" es el tipo seleccionado, elija una VM concreta de la Máquinas virtuales lista desplegable.)

      O

      • Habilite el Usar etiqueta opción y seleccione una etiqueta disponible de la lista desplegable para basar el evento en objetos con esa etiqueta correspondiente. (Por ejemplo, si "Máquinas virtuales" es el tipo seleccionado y "production" se selecciona en la Etiqueta lista desplegable, el desencadenante del evento corresponde a cualquier VM asignada con la etiqueta "production".)

    • Tarea: Seleccione la tarea creada en el paso anterior.

  4. Haga clic en Enviar para guardar el evento.


Compatibilidad de versiones: Esta funcionalidad está disponible en VergeOS 26.0 y versiones posteriores.

Última actualización

¿Te fue útil?