Pular para o conteúdo principal

🌐 Gatilho de Webhook

O Gatilho de Webhook permite que sistemas externos iniciem fluxos de trabalho no SmartFlow enviando dados via requisições API. Este gatilho é ideal para integrar o SmartFlow com aplicações de terceiros, permitindo a automação dinâmica e contínua de tarefas.

pasted-image.png

📝 Detalhes do Gatilho​

Nome: Webhook
Categoria: Gatilhos

🔧 Parâmetros​

1. Webhook URL​

  • Tipo: string
  • Descrição: A URL do endpoint para o webhook receber solicitações de entrada. Isso é gerado automaticamente para cada fluxo de trabalho que utiliza este gatilho.
  • Obrigatório: Sim
  • Exemplo: 
    https://api.smartflow.com/webhooks/{workflowId}

2. Payload​

  • Tipo: object
  • Descrição: Os dados enviados pelo sistema externo no corpo da solicitação. Este payload pode incluir campos personalizados dependendo da integração.
  • Obrigatório: Sim
  • Exemplo: 
    {
      "event": "order_created",
      "orderId": "12345",
      "customer": {
        "name": "John Doe",
        "email": "john@example.com"
      }
    }

3. Headers​

  • Tipo: object
  • Descrição: Cabeçalhos opcionais que o sistema externo pode incluir para fins de autenticação ou metadados.
  • Obrigatório: Não
  • Exemplo: 
    {
      "Authorization": "Bearer your-api-key",
      "Content-Type": "application/json"
    }

🚀 Como Funciona​

  1. Configuração da URL do Webhook:

    • Ao criar um fluxo de trabalho com um Gatilho de Webhook, o SmartFlow gera uma URL única para o webhook.
    • Compartilhe esta URL com o sistema externo para configurar sua integração.

  2. Recuperação da Chave da API:

    • Navegue até Configurações do ChatModel.
    • Vá para Integração → Web.
    • Clique em Copiar Chave da API para recuperar o token de autenticação necessário.

  3. Estrutura do Payload:

    • Sistemas externos enviam dados (payload) para a URL do webhook usando uma solicitação HTTP POST.
    • O payload deve corresponder à estrutura exigida pelo fluxo de trabalho.

  4. Execução do Gatilho:

    • Quando o webhook recebe uma solicitação válida, o fluxo de trabalho associado é acionado automaticamente.
    • O SmartFlow processa o payload, executa as ações definidas e retorna uma resposta, se necessário.

💡 Casos de Uso​

  1. Integração com CRM:

    • Cenário: Um cliente cria uma nova conta em seu sistema CRM.
    • Webhook: O CRM envia uma solicitação POST para o SmartFlow com os detalhes do cliente.
    • Fluxo de Trabalho: Envia um e-mail de boas-vindas e adiciona o cliente à sua lista de marketing.

  2. Gerenciamento de Pedidos:

    • Cenário: Uma plataforma de e-commerce processa um novo pedido.
    • Webhook: A plataforma envia os detalhes do pedido para o SmartFlow.
    • Fluxo de Trabalho: Atualiza o estoque, envia um e-mail de confirmação de pedido e notifica o armazém.

  3. Monitoramento de Incidentes:

    • Cenário: Um sistema de monitoramento detecta um erro crítico.
    • Webhook: O sistema envia um alerta para o SmartFlow.
    • Fluxo de Trabalho: Cria um relatório de incidente e notifica a equipe de engenharia.

🔍 Exemplo de Configuração​

Solicitação de Webhook de Entrada​

URL:

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

Carga Útil:

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

Cabeçalhos:

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

🛠️ Melhores Práticas​

  1. Validação:

    • Valide as requisições recebidas para garantir a integridade dos dados e prevenir abusos.
    • Use cabeçalhos ou tokens seguros para autenticação.

  2. Segurança da Chave da API:

    • Garanta que a chave da API recuperada de ChatModel Settings → Integration → Web seja mantida em segurança e não exposta publicamente.

  3. Mapeamento de Dados:

    • Mapeie claramente os campos recebidos para variáveis de fluxo de trabalho para um processamento sem interrupções.

  4. Testes:

    • Teste o webhook com cargas úteis de exemplo para garantir compatibilidade e confiabilidade.

  5. Tratamento de Erros:

    • Configure fluxos de trabalho para lidar com dados ausentes ou malformados de forma elegante.

📊 Monitoramento e Depuração​

  • Registros de Atividade:
    Acompanhe as solicitações de webhook recebidas e seu status de processamento no painel do SmartFlow.

  • Relatório de Erros:
    Identifique solicitações falhadas e visualize detalhes de erros para solução de problemas.

Esta seção fornece um guia detalhado para o Webhook Trigger, garantindo que os usuários possam integrá-lo perfeitamente em seus fluxos de trabalho. Avise-me se precisar de algum ajuste!