Saltar al contenido principal

🌐 Disparador de Webhook

El Disparador de Webhook permite que sistemas externos inicien flujos de trabajo en SmartFlow enviando datos a través de solicitudes API. Este disparador es ideal para integrar SmartFlow con aplicaciones de terceros, permitiendo la automatización dinámica y fluida de tareas.

pasted-image.png

📝 Detalles del Disparador​

Nombre: Webhook
Categoría: Disparadores

🔧 Parámetros​

1. Webhook URL​

  • Tipo: string
  • Descripción: La URL del endpoint para el webhook que recibe solicitudes entrantes. Esto se genera automáticamente para cada flujo de trabajo que utiliza este disparador.
  • Requerido: Sí
  • Ejemplo: 
    https://api.smartflow.com/webhooks/{workflowId}

2. Payload​

  • Tipo: object
  • Descripción: Los datos enviados por el sistema externo en el cuerpo de la solicitud. Este payload puede incluir campos personalizados dependiendo de la integración.
  • Requerido: Sí
  • Ejemplo: 
    {
      "event": "order_created",
      "orderId": "12345",
      "customer": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }

3. Headers​

  • Tipo: object
  • Descripción: Encabezados opcionales que el sistema externo podría incluir para fines de autenticación o metadatos.
  • Requerido: No
  • Ejemplo: 
    {
      "Authorization": "Bearer your-api-key",
      "Content-Type": "application/json"
    }

🚀 Cómo Funciona​

  1. Configuración de la URL del Webhook:

    • Al crear un flujo de trabajo con un Disparador de Webhook, SmartFlow genera una URL única para el webhook.
    • Comparte esta URL con el sistema externo para configurar su integración.

  2. Recuperación de la Clave API:

    • Navega a Configuraciones del ChatModel.
    • Ve a Integración → Web.
    • Haz clic en Copiar Clave API para recuperar el token de autenticación necesario.

  3. Estructura del Payload:

    • Los sistemas externos envían datos (payload) a la URL del webhook utilizando una solicitud HTTP POST.
    • El payload debe coincidir con la estructura requerida por el flujo de trabajo.

  4. Ejecución del Disparador:

    • Cuando el webhook recibe una solicitud válida, el flujo de trabajo asociado se activa automáticamente.
    • SmartFlow procesa el payload, ejecuta las acciones definidas y devuelve una respuesta si es necesario.

💡 Casos de Uso​

  1. Integración de CRM:

    • Escenario: Un cliente crea una nueva cuenta en su sistema CRM.
    • Webhook: El CRM envía una solicitud POST a SmartFlow con los detalles del cliente.
    • Flujo de trabajo: Envía un correo electrónico de bienvenida y añade al cliente a su lista de marketing.

  2. Gestión de Pedidos:

    • Escenario: Una plataforma de comercio electrónico procesa un nuevo pedido.
    • Webhook: La plataforma envía los detalles del pedido a SmartFlow.
    • Flujo de trabajo: Actualiza el inventario, envía un correo electrónico de confirmación del pedido y notifica al almacén.

  3. Monitoreo de Incidentes:

    • Escenario: Un sistema de monitoreo detecta un error crítico.
    • Webhook: El sistema envía una alerta a SmartFlow.
    • Flujo de trabajo: Crea un informe de incidente y notifica al equipo de ingeniería.

🔍 Ejemplo de Configuración​

Solicitud de Webhook Entrante​

URL:

https://api.smartflow.com/webhooks/abc123

Carga Útil:

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Encabezados:

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

🛠️ Mejores Prácticas​

  1. Validación:

    • Valida las solicitudes entrantes para asegurar la integridad de los datos y prevenir el uso indebido.
    • Utiliza encabezados o tokens seguros para la autenticación.

  2. Seguridad de la Clave API:

    • Asegúrate de que la clave API recuperada de ChatModel Settings → Integration → Web se mantenga segura y no se exponga públicamente.

  3. Mapeo de Datos:

    • Mapea claramente los campos entrantes a las variables del flujo de trabajo para un procesamiento sin problemas.

  4. Pruebas:

    • Prueba el webhook con cargas útiles de muestra para asegurar la compatibilidad y confiabilidad.

  5. Manejo de Errores:

    • Configura los flujos de trabajo para manejar datos faltantes o malformados de manera adecuada.

📊 Monitoreo y Depuración​

  • Registros de Actividad:
    Realiza un seguimiento de las solicitudes de webhook entrantes y su estado de procesamiento en el panel de SmartFlow.

  • Informe de Errores:
    Identifica las solicitudes fallidas y visualiza los detalles de los errores para la resolución de problemas.

Esta sección proporciona una guía detallada para el Disparador de Webhook, asegurando que los usuarios puedan integrarlo sin problemas en sus flujos de trabajo. ¡Déjame saber si necesitas alguna mejora!