Webhook Request Node

O Webhook Request Node é usado para iniciar um Workflow a partir de uma chamada HTTP externa.
Ele permite que a Zaia Endless receba dados enviados por qualquer sistema externo, como CRMs, sites ou plataformas de automação.

Este node atua efetivamente como um ponto de entrada para integrações externas, permitindo que outros sistemas acionem a execução de um Workflow dentro do Endless.

---

🛠️ Como Funciona

Quando um Webhook Request Node é adicionado a um Workflow, o Endless gera automaticamente uma Test URL — um endpoint único que escuta requisições HTTP recebidas.

Serviços externos (como manipuladores de formulário, sistemas de backend ou aplicativos de terceiros) podem enviar dados para essa URL usando um dos métodos suportados.
Cada requisição pode incluir headers, parâmetros de query ou payloads de body, que são capturados e disponibilizados para os nodes seguintes no Workflow.

Métodos HTTP Suportados:
GET, POST, PUT, DELETE, PATCH

---

⚙️ Opções de Configuração

Configuração	Descrição
Test URL	Um endpoint único gerado automaticamente para o node. Use-o para enviar requisições de sistemas externos.
Method	Selecione o método HTTP que o webhook aceitará (ex.: POST para payloads JSON).
Allowed Origins	Restringe quais domínios ou fontes podem chamar esse endpoint. Se vazio, qualquer origem é permitida.
Authentication Type	Define como as requisições são autorizadas antes da execução (veja abaixo).
Response	Controla como e quando o Endless retorna uma resposta (Immediate ou Webhook Response Node).
Response Code	Permite definir o código de status HTTP a ser retornado (ex.: 200, 201, 400).

---

🔒 Opções de Autenticação

O Webhook Request Node suporta dois modos de autenticação:

1. None

Nenhuma autenticação é exigida. Qualquer sistema pode acionar o webhook.

Use este modo para testes ou integrações públicas onde a segurança não é crítica.

---

2. Bearer Authentication

Protege o webhook usando um Bearer Token de um Credential Pool.

Quando selecionado:

1. Escolha ou crie um Credential Pool (tipo: API Key).
2. Gere um token dentro desse pool.
3. Copie o token gerado — ele será exigido nas requisições HTTP externas.

Exemplo de requisição:

POST https://z-sovereign-service-staging.fly.dev/platform/v1/workflows/capture
Authorization: Bearer 6c8c5187-2f0c-47de-bae0-de22a4855340
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com"
}

Se a requisição não incluir um token válido do pool selecionado, o Endless a rejeitará com uma resposta 401 Unauthorized.

⚙️ Credential Pools podem conter múltiplos tokens e podem ser gerenciados ou revogados a qualquer momento.
Isso permite um gerenciamento de credenciais seguro e centralizado para diferentes integrações.

---

🧪 Modo de Teste do Node

O recurso Node Test permite simular e validar requisições de webhook recebidas diretamente dentro do Endless antes de fazer o deploy do Workflow.

Ao clicar em “Execute Test”, o node entra em modo de escuta, aguardando uma requisição HTTP recebida na Test URL gerada.
Assim que uma requisição é recebida, o painel exibe uma prévia estruturada dos dados recebidos.

Exemplo de saída de teste:

{
  "snapshot": {
    "body": {
      "name": "New name",
      "test": "data01"
    },
    "headers": {
      "authorization": "Bearer 6c8c5187-2f0c-47de-bae0-de22a4855340",
      "content-type": "application/json"
    },
    "method": "POST",
    "query": {}
  }
}

Após a conclusão do teste, você pode usar esses dados recebidos como input para os nodes seguintes no mesmo Workflow — ideal para testes ponta a ponta e validação de schema.

🧠 Dica:
Use o modo Node Test para verificar as estruturas de payload antes de integrar sistemas de produção.
Isso garante que o mapeamento de campos e a autenticação estejam configurados corretamente.

---

🔁 Comportamento da Resposta

A configuração Response determina quando o webhook retorna uma resposta:

Modo	Comportamento
Immediate	O Endless responde imediatamente após receber a requisição, sem esperar o restante do Workflow ser concluído.
Webhook Response Node	O Endless aguarda até que um Webhook Response Node dedicado seja executado mais adiante no Workflow — permitindo retornar dados dinâmicos e processados ao solicitante.

Exemplo de caso de uso:

• Use Immediate para triggers assíncronos (ex.: registrar um evento em log).
• Use Webhook Response Node para integrações síncronas em que o sistema externo espera uma resposta processada.

---

📌 Exemplos de Uso

Cenário	Descrição
Captura de Lead	Receber um lead de um formulário de site e acionar um workflow para armazená-lo em uma Table ou CRM.
Sincronização de CRM	Capturar atualizações de outro sistema e propagá-las entre Agentes ou integrações.
Triggers de Evento Externo	Iniciar um workflow quando ocorre um evento externo — ex.: um novo pagamento, criação de ticket ou chamada de API.
Integrações Internas	Conectar Workflows da Zaia Endless a aplicativos internos por meio de webhooks com autenticação Bearer segura.

---

✅ Boas Práticas

1. Sempre use autenticação Bearer para webhooks de produção.
2. Restrinja origens sempre que possível para reduzir a exposição.
3. Teste payloads com a ferramenta Node Test antes de conectar sistemas externos.
4. Documente os códigos de resposta esperados pelo sistema que está chamando.
5. Regenere tokens periodicamente nos Credential Pools para maior segurança.

---

🧠 Resumo

Recurso	Descrição
Purpose	Inicia um Workflow por meio de uma chamada HTTP externa.
Authentication	Suporta None ou Bearer (via Credential Pools).
Test Mode	Permite captura de requisições reais e inspeção de dados dentro do node.
Response Handling	Immediate ou via Webhook Response Node.
Security	Origens configuráveis, gerenciamento de tokens e rotação de credenciais.

---

🚀 Nota Final

O Webhook Request Node transforma a Zaia Endless em um hub de integração — capaz de receber dados de qualquer sistema de forma segura, controlada e testável.
Com autenticação nativa, testes em tempo real e tratamento flexível de respostas, ele oferece uma base poderosa para construir automações fluidas e orientadas a eventos.