Disparadores Webhook: Adición y Configuración
A continuación, conoce cómo añadir y configurar un Disparador Webhook:
Adición de un Disparador Webhook Simple (HTTP)
Para añadir un Disparador Webhook, sigue estos pasos:
Haz clic en "Empieza con un disparador".
Haz clic en el signo de más de la opción Webhook. Después se abrirá el modal para configurarlo y visualizar más información.
Este modal está dividido en las siguientes áreas: Encabezado, Configuraciones y Especificaciones de la Solicitud.
Consulta sobre el Encabezado del Módulo aquí.
Configuraciones
Por defecto, la dirección del Webhook está predefinida en Skyone Studio, siendo posible copiarla haciendo clic en el ícono específico ubicado en el lado derecho de la pantalla.
Además, existe la opción de "Solicitar autenticación". Sin utilizar OpenAPI, solo tendrás la opción de activar la solicitud de autenticación con Usuario (predefinido) y Contraseña (obligatoria), los cuales no serán requeridos al ejecutar el flujo dentro de Skyone Studio.
Especificaciones de la solicitud
Los flujos de Skyone Data pueden ser activados utilizando los siguientes formatos de MEDIA TYPE (tipo de medio):
application/json
application/x-www-form-urlencoded
Selecciona uno de los dos según tu necesidad, usando la flecha en la esquina derecha.
Límite de ejecuciones
Es posible gestionar la cantidad de ejecuciones de tu Disparador Webhook a través del "Límite de Ejecuciones", es decir, determinar el número máximo de veces que el Webhook será solicitado durante un período de tiempo.
Para ello, elige el número y la unidad de tiempo deseada (segundo, minuto u hora).
BODY
En "Usar Body en la solicitud", utiliza el botón de activación para mostrar el recurso. Por defecto, la pestaña Body se presenta:
Este campo permite que utilices un body en formato JSON, el cual puedes o no querer convertir a YAML. Cuando se utiliza, aparece como un parámetro con el mismo nombre (body) en los demás componentes del flujo, siendo posible filtrar sus datos mediante un SMOP o el módulo de herramientas Data Transformation.
Si deseas utilizar el formato JSON para que Skyone Studio convierta el código a YAML, utiliza esta pestaña de configuración del Disparador Webhook y haz clic en "Generar Schema".
Skyone Studio verificará si tu JSON es válido y, si todo está correcto, generará automáticamente tu schema en YAML.
Opcionalmente, puedes utilizar únicamente el BODY, sin generar un schema en YAML, haciendo clic en "Guardar" para conservar los cambios. Esto hará que Skyone Data no realice la validación del tipo de parámetro utilizado.
Si existe algún error, verifica el mensaje de error, realiza las correcciones necesarias e inténtalo nuevamente.
Adición de un Disparador Webhook con OpenAPI Schemas (HTTP)
Además de añadir un Disparador Webhook simple, podemos añadir uno utilizando OpenAPI —configuraciones opcionales que permiten pasar parámetros directamente en el disparador, al inicio de la solicitud POST.
Para comenzar, en "Usar Body en la solicitud", activa el botón para habilitar el recurso. Luego, selecciona la pestaña "Open API Schemas."
Aquí tendrás la opción de especificar tu schema, añadiendo parámetros en caso de que desees escribir tu schema directamente en YAML. Cualquier parámetro añadido debe estar contenido en la variable webhook_request. En el ejemplo anterior, tenemos un schema simple con el parámetro csv, que debe ser de tipo string. Este parámetro debe proporcionarse al momento de la solicitud mediante POSTMAN (o similar). Para una mejor visualización, sigue el mismo código en texto:
Para finalizar las configuraciones del disparador, haz clic en "Guardar".
Lee también: Editar disparadores
Last updated